Skip to content

Commit 2f67eb2

Browse files
authored
docs: Add page descriptions (#1056)
* docs: Add page descriptions * docs: Include the resource requests partial * docs: Fix the resource requests include
1 parent a4f09e5 commit 2f67eb2

15 files changed

Lines changed: 15 additions & 1 deletion

‎docs/modules/kafka/pages/reference/commandline-parameters.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Command line parameters
2+
:description: Command-line parameters the Stackable operator for Apache Kafka accepts, with their default values and usage examples.
23

34
This operator accepts the following command line parameters:
45

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
= CRD Reference
2+
:description: CRD reference for the Stackable operator for Apache Kafka on the Stackable Hub, covering every field, default and API version.
23

34
Find all CRD reference for the Stackable Operator for Apache Kafka at: {crd-ref}{crd-ref-release}&operator=kafka-operator.

‎docs/modules/kafka/pages/reference/discovery.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
:brokerPort: 9092
44

55
= Discovery
6+
:description: Reference for the discovery ConfigMap the Stackable operator for Apache Kafka publishes, with the connection string other tools use to reach the brokers.
67
:page-aliases: discovery.adoc
78

89
The Stackable Operator for Apache Kafka publishes a xref:concepts:service_discovery.adoc[service discovery ConfigMap] which exposes a client configuration bundle that allows access to the Apache Kafka cluster.

‎docs/modules/kafka/pages/reference/environment-variables.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Environment variables
2+
:description: Environment variables the Stackable operator for Apache Kafka accepts, with their default values and what each one controls.
23

34
This operator accepts the following environment variables:
45

‎docs/modules/kafka/pages/reference/index.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Reference
2+
:description: Reference for the Stackable operator for Apache Kafka, covering CRD fields, discovery ConfigMap properties, command-line parameters and environment variables.
23

34
Consult the reference documentation section to find exhaustive information on:
45

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
= Usage guide
2+
:description: Guides for Apache Kafka on Kubernetes, covering KRaft controllers, service exposition, security, storage, logging, monitoring and overrides.
23
:page-aliases: usage.adoc

‎docs/modules/kafka/pages/usage-guide/listenerclass.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Service exposition with ListenerClasses
2+
:description: Exposing Apache Kafka brokers with ListenerClasses, covering the bootstrap and per-broker Listeners the operator creates for client connections.
23

34
The operator deploys a bootstrap xref:listener-operator:listener.adoc[Listener] for each broker rolegroup, as well as a xref:listener-operator:listener.adoc[Listener] for each broker pod.
45

‎docs/modules/kafka/pages/usage-guide/operations/cluster-operations.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11

22
= Cluster operation
3+
:description: Cluster operations for Apache Kafka, covering how to pause reconciliation of a cluster or stop it entirely through its custom resource.
34

45
The managed Kafka instances can be configured with different cluster operations like pausing reconciliation or stopping the cluster. See xref:concepts:operations/cluster_operations.adoc[cluster operations] for more details.
56

‎docs/modules/kafka/pages/usage-guide/operations/graceful-shutdown.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Graceful shutdown
2+
:description: Graceful shutdown of Apache Kafka brokers, covering the shutdown timeout and how brokers hand over partition leadership before stopping.
23

34
You can configure the graceful shutdown as described in xref:concepts:operations/graceful_shutdown.adoc[].
45

‎docs/modules/kafka/pages/usage-guide/operations/index.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Operations
2+
:description: Operating Apache Kafka with the Stackable operator, covering graceful shutdown, Pod disruptions, Pod placement, cluster IDs and cluster operations.
23

34
This section of the documentation is intended for the operations teams that maintain a Stackable Data Platform installation.
45

0 commit comments

Comments
 (0)