Skip to content

feat(docs): Reference documentation #650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 27, 2023
Merged

feat(docs): Reference documentation #650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc761aa
WIP
Dec 24, 2023
d0d38be
~
Dec 24, 2023
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 0 additions & 73 deletions docs/modules/kafka/pages/config_properties.adoc
View file
Open in desktop

This file was deleted.

15 changes: 0 additions & 15 deletions docs/modules/kafka/pages/configuration.adoc
View file
Open in desktop

This file was deleted.

7 changes: 5 additions & 2 deletions ...modules/kafka/pages/commandline_args.adoc → ...ges/reference/commandline-parameters.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
= Command line parameters

=== product-config
This operator accepts the following command line parameters:

== product-config

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

Expand All @@ -12,7 +15,7 @@
stackable-kafka-operator run --product-config /foo/bar/properties.yaml
----

=== watch-namespace
== watch-namespace

*Default value*: All namespaces

Expand Down
3 changes: 3 additions & 0 deletions docs/modules/kafka/pages/reference/crds.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
= CRD Reference

Find all CRD reference for the Stackable Operator for Apache Kafka at: {crd-docs-base-url}/kafka-operator/{crd-docs-version}.
0 ...es/kafka/pages/usage-guide/discovery.adoc → ...ules/kafka/pages/reference/discovery.adoc
View file
Open in desktop
File renamed without changes.
7 changes: 5 additions & 2 deletions docs/modules/kafka/pages/env_var_args.adoc → ...ages/reference/environment-variables.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
= Environment variables

=== PRODUCT_CONFIG
This operator accepts the following environment variables:

== PRODUCT_CONFIG

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

Expand All @@ -25,7 +28,7 @@ docker run \
docker.stackable.tech/stackable/kafka-operator:latest
----

=== WATCH_NAMESPACE
== WATCH_NAMESPACE

*Default value*: All namespaces

Expand Down
7 changes: 7 additions & 0 deletions docs/modules/kafka/pages/reference/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
= Reference

Consult the reference documentation section to find exhaustive information on:

* Descriptions and default values of all properties in the CRDs used by this operator in the xref:reference/crds.adoc[].
* The properties in the xref:reference/discovery.adoc[].
* The xref:reference/commandline-parameters.adoc[] and xref:reference/environment-variables.adoc[] accepted by the operator.
9 changes: 7 additions & 2 deletions docs/modules/kafka/partials/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
* xref:kafka:getting_started/index.adoc[]
** xref:kafka:getting_started/installation.adoc[]
** xref:kafka:getting_started/first_steps.adoc[]
* xref:kafka:configuration.adoc[]
* xref:kafka:usage-guide/index.adoc[]
** xref:kafka:usage-guide/storage-resources.adoc[]
** xref:kafka:usage-guide/security.adoc[]
** xref:kafka:usage-guide/discovery.adoc[]
** xref:kafka:usage-guide/monitoring.adoc[]
** xref:kafka:usage-guide/logging.adoc[]
** xref:kafka:usage-guide/configuration-environment-overrides.adoc[]
Expand All @@ -15,3 +13,10 @@
*** xref:kafka:usage-guide/operations/pod-disruptions.adoc[]
*** xref:kafka:usage-guide/operations/graceful-shutdown.adoc[]
*** xref:kafka:usage-guide/operations/znode-id.adoc[]
* xref:kafka:reference/index.adoc[]
** xref:kafka:reference/crds.adoc[]
*** {crd-docs}/kafka.stackable.tech/kafkacluster/v1alpha1/[KafkaCluster {external-link-icon}^]
** xref:kafka:reference/discovery.adoc[]
** xref:kafka:reference/commandline-parameters.adoc[]
** xref:kafka:reference/environment-variables.adoc[]