Update Kafka exporter doc, add instruction to generate ascidoc (#242)

netobserv · Jan 6, 2023 · ff9cd22 · ff9cd22
1 parent 91a9ab5
commit ff9cd22
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 9 deletions.
diff --git a/api/v1alpha1/flowcollector_types.go b/api/v1alpha1/flowcollector_types.go
@@ -652,7 +652,7 @@ type FlowCollectorExporter struct {
 	// +kubebuilder:validation:Required
 	Type ExporterType `json:"type"`
 
-	// kafka describes the kafka configuration (address, topic...) to send enriched flows to.
+	// kafka configuration, such as address or topic, to send enriched flows to.
 	// +optional
 	Kafka FlowCollectorKafka `json:"kafka,omitempty"`
 }

diff --git a/bundle/manifests/flows.netobserv.io_flowcollectors.yaml b/bundle/manifests/flows.netobserv.io_flowcollectors.yaml
@@ -975,8 +975,8 @@ spec:
                     to send enriched flows to
                   properties:
                     kafka:
-                      description: kafka describes the kafka configuration (address,
-                        topic...) to send enriched flows to.
+                      description: kafka configuration, such as address or topic,
+                        to send enriched flows to.
                       properties:
                         address:
                           default: ""

diff --git a/config/crd/bases/flows.netobserv.io_flowcollectors.yaml b/config/crd/bases/flows.netobserv.io_flowcollectors.yaml
@@ -973,8 +973,8 @@ spec:
                     to send enriched flows to
                   properties:
                     kafka:
-                      description: kafka describes the kafka configuration (address,
-                        topic...) to send enriched flows to.
+                      description: kafka configuration, such as address or topic,
+                        to send enriched flows to.
                       properties:
                         address:
                           default: ""

diff --git a/docs/FlowCollector.md b/docs/FlowCollector.md
@@ -1688,7 +1688,7 @@ FlowCollectorExporter defines an additional exporter to send enriched flows to
         <td><b><a href="#flowcollectorspecexportersindexkafka">kafka</a></b></td>
         <td>object</td>
         <td>
-          kafka describes the kafka configuration (address, topic...) to send enriched flows to.<br/>
+          kafka configuration, such as address or topic, to send enriched flows to.<br/>
         </td>
         <td>false</td>
       </tr></tbody>
@@ -1700,7 +1700,7 @@ FlowCollectorExporter defines an additional exporter to send enriched flows to
 
 
 
-kafka describes the kafka configuration (address, topic...) to send enriched flows to.
+kafka configuration, such as address or topic, to send enriched flows to.
 
 <table>
     <thead>

diff --git a/docs/GeneratingAsciidocAPI.md b/docs/GeneratingAsciidocAPI.md
@@ -0,0 +1,13 @@
+# Generating Asciidoc API reference
+
+## Setup docsgen repo
+
+1. Clone https://github.com/jboxman-rh/openshift-apidocs-gen
+2. run `npm install -g`
+
+## Run it
+
+The doc generator needs to talk with a running cluster, with the desired CRDs installed.
+
+1. Deploy netobserv CRD on your cluster (e.g. deploy just the operator; no need to install everything, just the CRD is needed).
+2. run `hack/asciidoc-gen.sh`
diff --git a/docs/flowcollector-flows-netobserv-io-v1alpha1.adoc b/docs/flowcollector-flows-netobserv-io-v1alpha1.adoc
@@ -549,7 +549,7 @@ Required::
 
 | `kafka`
 | `object`
-| kafka describes the kafka configuration (address, topic...) to send enriched flows to.
+| kafka configuration, such as address or topic, to send enriched flows to.
 
 | `type`
 | `string`
@@ -560,7 +560,7 @@ Required::
 Description::
 +
 --
-kafka describes the kafka configuration (address, topic...) to send enriched flows to.
+kafka configuration, such as address or topic, to send enriched flows to.
 --
 
 Type::