Skip to content

Commit fdcacd7

Browse files
authored
feat(docs): Reference documentation (#650)
* WIP * ~
1 parent a4c4d99 commit fdcacd7

File tree

8 files changed

+27
-94
lines changed

8 files changed

+27
-94
lines changed

docs/modules/kafka/pages/config_properties.adoc

Lines changed: 0 additions & 73 deletions
This file was deleted.

docs/modules/kafka/pages/configuration.adoc

Lines changed: 0 additions & 15 deletions
This file was deleted.

docs/modules/kafka/pages/commandline_args.adoc renamed to docs/modules/kafka/pages/reference/commandline-parameters.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1+
= Command line parameters
12

2-
=== product-config
3+
This operator accepts the following command line parameters:
4+
5+
== product-config
36

47
*Default value*: `/etc/stackable/kafka-operator/config-spec/properties.yaml`
58

@@ -12,7 +15,7 @@
1215
stackable-kafka-operator run --product-config /foo/bar/properties.yaml
1316
----
1417

15-
=== watch-namespace
18+
== watch-namespace
1619

1720
*Default value*: All namespaces
1821

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
= CRD Reference
2+
3+
Find all CRD reference for the Stackable Operator for Apache Kafka at: {crd-docs-base-url}/kafka-operator/{crd-docs-version}.
File renamed without changes.

docs/modules/kafka/pages/env_var_args.adoc renamed to docs/modules/kafka/pages/reference/environment-variables.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1+
= Environment variables
12

2-
=== PRODUCT_CONFIG
3+
This operator accepts the following environment variables:
4+
5+
== PRODUCT_CONFIG
36

47
*Default value*: `/etc/stackable/kafka-operator/config-spec/properties.yaml`
58

@@ -25,7 +28,7 @@ docker run \
2528
docker.stackable.tech/stackable/kafka-operator:latest
2629
----
2730

28-
=== WATCH_NAMESPACE
31+
== WATCH_NAMESPACE
2932

3033
*Default value*: All namespaces
3134

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
= Reference
2+
3+
Consult the reference documentation section to find exhaustive information on:
4+
5+
* Descriptions and default values of all properties in the CRDs used by this operator in the xref:reference/crds.adoc[].
6+
* The properties in the xref:reference/discovery.adoc[].
7+
* The xref:reference/commandline-parameters.adoc[] and xref:reference/environment-variables.adoc[] accepted by the operator.
Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
* xref:kafka:getting_started/index.adoc[]
22
** xref:kafka:getting_started/installation.adoc[]
33
** xref:kafka:getting_started/first_steps.adoc[]
4-
* xref:kafka:configuration.adoc[]
54
* xref:kafka:usage-guide/index.adoc[]
65
** xref:kafka:usage-guide/storage-resources.adoc[]
76
** xref:kafka:usage-guide/security.adoc[]
8-
** xref:kafka:usage-guide/discovery.adoc[]
97
** xref:kafka:usage-guide/monitoring.adoc[]
108
** xref:kafka:usage-guide/logging.adoc[]
119
** xref:kafka:usage-guide/configuration-environment-overrides.adoc[]
@@ -15,3 +13,10 @@
1513
*** xref:kafka:usage-guide/operations/pod-disruptions.adoc[]
1614
*** xref:kafka:usage-guide/operations/graceful-shutdown.adoc[]
1715
*** xref:kafka:usage-guide/operations/znode-id.adoc[]
16+
* xref:kafka:reference/index.adoc[]
17+
** xref:kafka:reference/crds.adoc[]
18+
*** {crd-docs}/kafka.stackable.tech/kafkacluster/v1alpha1/[KafkaCluster {external-link-icon}^]
19+
** xref:kafka:reference/discovery.adoc[]
20+
** xref:kafka:reference/commandline-parameters.adoc[]
21+
** xref:kafka:reference/environment-variables.adoc[]
22+

0 commit comments

Comments
 (0)