From e483a5c5986c1f4431fec930ed125ecddc248aa5 Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Thu, 5 Nov 2026 13:24:44 +0100 Subject: [PATCH] docs: Add page descriptions --- docs/modules/secret-operator/pages/installation.adoc | 1 + .../secret-operator/pages/reference/commandline-parameters.adoc | 1 + docs/modules/secret-operator/pages/reference/crds.adoc | 1 + .../secret-operator/pages/reference/environment-variables.adoc | 1 + docs/modules/secret-operator/pages/reference/index.adoc | 1 + docs/modules/secret-operator/pages/troubleshooting.adoc | 1 + docs/modules/secret-operator/pages/usage.adoc | 1 + 7 files changed, 7 insertions(+) diff --git a/docs/modules/secret-operator/pages/installation.adoc b/docs/modules/secret-operator/pages/installation.adoc index 3c315939..5eab1fd6 100644 --- a/docs/modules/secret-operator/pages/installation.adoc +++ b/docs/modules/secret-operator/pages/installation.adoc @@ -1,4 +1,5 @@ = Installation +:description: Installation of the Stackable secret operator with Helm, covering the settings for Kubernetes distributions such as MicroK8s, k0s and VMware Tanzu. There are two ways to run the Stackable Secret Operator: diff --git a/docs/modules/secret-operator/pages/reference/commandline-parameters.adoc b/docs/modules/secret-operator/pages/reference/commandline-parameters.adoc index 0b721859..8a55caa6 100644 --- a/docs/modules/secret-operator/pages/reference/commandline-parameters.adoc +++ b/docs/modules/secret-operator/pages/reference/commandline-parameters.adoc @@ -1,4 +1,5 @@ = Command line parameters +:description: Command-line parameters the Stackable secret operator accepts, such as the required CSI endpoint socket path, with their environment variable equivalents. This operator accepts the following command line parameters: diff --git a/docs/modules/secret-operator/pages/reference/crds.adoc b/docs/modules/secret-operator/pages/reference/crds.adoc index 1f1cf936..030b85d7 100644 --- a/docs/modules/secret-operator/pages/reference/crds.adoc +++ b/docs/modules/secret-operator/pages/reference/crds.adoc @@ -1,3 +1,4 @@ = CRD Reference +:description: CRD reference for the Stackable secret operator on the Stackable Hub, covering every field, default and API version. Find all CRD reference for the Stackable Secret Operator at: {crd-ref}{crd-ref-release}&operator=secret-operator. diff --git a/docs/modules/secret-operator/pages/reference/environment-variables.adoc b/docs/modules/secret-operator/pages/reference/environment-variables.adoc index 5aee63b2..40ea4b64 100644 --- a/docs/modules/secret-operator/pages/reference/environment-variables.adoc +++ b/docs/modules/secret-operator/pages/reference/environment-variables.adoc @@ -1,4 +1,5 @@ = Environment variables +:description: Environment variables the Stackable secret operator accepts, including the required CSI endpoint socket, with what each one controls and its default. This operator accepts the following environment variables: diff --git a/docs/modules/secret-operator/pages/reference/index.adoc b/docs/modules/secret-operator/pages/reference/index.adoc index fbe48845..6a924aca 100644 --- a/docs/modules/secret-operator/pages/reference/index.adoc +++ b/docs/modules/secret-operator/pages/reference/index.adoc @@ -1,4 +1,5 @@ = Reference +:description: Reference for the Stackable secret operator, covering CRD fields, command-line parameters and environment variables, with their default values. Consult the reference documentation section to find exhaustive information on: diff --git a/docs/modules/secret-operator/pages/troubleshooting.adoc b/docs/modules/secret-operator/pages/troubleshooting.adoc index dfa7dff3..14501732 100644 --- a/docs/modules/secret-operator/pages/troubleshooting.adoc +++ b/docs/modules/secret-operator/pages/troubleshooting.adoc @@ -1,4 +1,5 @@ = Troubleshooting +:description: Troubleshooting the Stackable secret operator, covering Pods stuck pending on secret volumes, PersistentVolumeClaim problems and Active Directory conflicts. [#general] == General diff --git a/docs/modules/secret-operator/pages/usage.adoc b/docs/modules/secret-operator/pages/usage.adoc index fbf77bfd..adb5ba61 100644 --- a/docs/modules/secret-operator/pages/usage.adoc +++ b/docs/modules/secret-operator/pages/usage.adoc @@ -1,4 +1,5 @@ = Usage +:description: Usage of the Stackable secret operator in other Pods through ephemeral volumes, and when a SecretClass on a stacklet is the better fit. The operator injects secret data into xref:volume.adoc[] mounts that declare an ephemeral volume with `storageClassName: secrets.stackable.tech`.