From 62e7c91f794d4657011c38152f9988c11258176d Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Thu, 5 Nov 2026 13:25:15 +0100 Subject: [PATCH 1/2] docs: Add page descriptions --- docs/modules/superset/pages/getting_started/first_steps.adoc | 1 + docs/modules/superset/pages/getting_started/index.adoc | 1 + docs/modules/superset/pages/getting_started/installation.adoc | 1 + .../modules/superset/pages/reference/commandline-parameters.adoc | 1 + docs/modules/superset/pages/reference/crds.adoc | 1 + docs/modules/superset/pages/reference/environment-variables.adoc | 1 + docs/modules/superset/pages/reference/index.adoc | 1 + .../pages/usage-guide/configuration-environment-overrides.adoc | 1 + .../pages/usage-guide/operations/cluster-operations.adoc | 1 + .../superset/pages/usage-guide/operations/graceful-shutdown.adoc | 1 + docs/modules/superset/pages/usage-guide/operations/index.adoc | 1 + .../superset/pages/usage-guide/operations/pod-disruptions.adoc | 1 + .../superset/pages/usage-guide/operations/pod-placement.adoc | 1 + 13 files changed, 13 insertions(+) diff --git a/docs/modules/superset/pages/getting_started/first_steps.adoc b/docs/modules/superset/pages/getting_started/first_steps.adoc index b3747def..5bf4e8ea 100644 --- a/docs/modules/superset/pages/getting_started/first_steps.adoc +++ b/docs/modules/superset/pages/getting_started/first_steps.adoc @@ -1,4 +1,5 @@ = First steps +:description: First steps with Apache Superset, covering a first instance with a metadata database and credentials, its web interface and the example dashboards. Once you have followed the steps in xref:getting_started/installation.adoc[] for the Operator and its dependencies, you will now go through the steps to set up and connect to a Superset instance. diff --git a/docs/modules/superset/pages/getting_started/index.adoc b/docs/modules/superset/pages/getting_started/index.adoc index 28314e85..3d893eb8 100644 --- a/docs/modules/superset/pages/getting_started/index.adoc +++ b/docs/modules/superset/pages/getting_started/index.adoc @@ -1,4 +1,5 @@ = Getting started +:description: Getting started with Apache Superset on Kubernetes, covering the Stackable operator and its dependencies, a first instance and sample data. This guide helps you get started with Superset using the Stackable Operator. It covers the installation of the Operator and its dependencies, setting up your first Superset instance, connecting to it, and exploring sample data. diff --git a/docs/modules/superset/pages/getting_started/installation.adoc b/docs/modules/superset/pages/getting_started/installation.adoc index 9174ffcc..d2084840 100644 --- a/docs/modules/superset/pages/getting_started/installation.adoc +++ b/docs/modules/superset/pages/getting_started/installation.adoc @@ -1,4 +1,5 @@ = Installation +:description: Installation of the Stackable operator for Apache Superset and the commons, secret and listener operators it depends on, with stackablectl or Helm. On this page you will install the Stackable Superset Operator as well as the commons, secret and listener operators which are required by all Stackable Operators. diff --git a/docs/modules/superset/pages/reference/commandline-parameters.adoc b/docs/modules/superset/pages/reference/commandline-parameters.adoc index 6402afcd..7dd83a8a 100644 --- a/docs/modules/superset/pages/reference/commandline-parameters.adoc +++ b/docs/modules/superset/pages/reference/commandline-parameters.adoc @@ -1,4 +1,5 @@ = Command Line Parameters +:description: Command-line parameters the Stackable operator for Apache Superset accepts, with their default values and usage examples. This operator accepts the following command line parameters: diff --git a/docs/modules/superset/pages/reference/crds.adoc b/docs/modules/superset/pages/reference/crds.adoc index eb9001cd..f197a44e 100644 --- a/docs/modules/superset/pages/reference/crds.adoc +++ b/docs/modules/superset/pages/reference/crds.adoc @@ -1,3 +1,4 @@ = CRD Reference +:description: CRD reference for the Stackable operator for Apache Superset on the Stackable Hub, covering every field, default and API version. Find all CRD reference for the Stackable Operator for Apache Superset at: {crd-ref}{crd-ref-release}&operator=superset-operator. diff --git a/docs/modules/superset/pages/reference/environment-variables.adoc b/docs/modules/superset/pages/reference/environment-variables.adoc index d07fcd84..d7475930 100644 --- a/docs/modules/superset/pages/reference/environment-variables.adoc +++ b/docs/modules/superset/pages/reference/environment-variables.adoc @@ -1,4 +1,5 @@ = Environment variables +:description: Environment variables the Stackable operator for Apache Superset accepts, with their default values and what each one controls. This operator accepts the following environment variables: diff --git a/docs/modules/superset/pages/reference/index.adoc b/docs/modules/superset/pages/reference/index.adoc index 3cfa0289..480b9244 100644 --- a/docs/modules/superset/pages/reference/index.adoc +++ b/docs/modules/superset/pages/reference/index.adoc @@ -1,4 +1,5 @@ = Reference +:description: Reference for the Stackable operator for Apache Superset, covering CRD fields, command-line parameters and environment variables. Consult the reference documentation section to find exhaustive information on: diff --git a/docs/modules/superset/pages/usage-guide/configuration-environment-overrides.adoc b/docs/modules/superset/pages/usage-guide/configuration-environment-overrides.adoc index 9b8e7eb2..28ecdc34 100644 --- a/docs/modules/superset/pages/usage-guide/configuration-environment-overrides.adoc +++ b/docs/modules/superset/pages/usage-guide/configuration-environment-overrides.adoc @@ -1,4 +1,5 @@ = Configuration & Environment Overrides +:description: Overrides for Apache Superset, covering configuration properties, environment variables and Pod specs per role or role group. The cluster definition also supports overriding configuration properties and environment variables, either per role or per role group, where the more specific override (role group) has precedence over diff --git a/docs/modules/superset/pages/usage-guide/operations/cluster-operations.adoc b/docs/modules/superset/pages/usage-guide/operations/cluster-operations.adoc index 4b869e65..83d52875 100644 --- a/docs/modules/superset/pages/usage-guide/operations/cluster-operations.adoc +++ b/docs/modules/superset/pages/usage-guide/operations/cluster-operations.adoc @@ -1,4 +1,5 @@ = Cluster Operation +:description: Cluster operations for Apache Superset, covering how to pause reconciliation of a cluster or stop it entirely through its custom resource. Superset installations 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. diff --git a/docs/modules/superset/pages/usage-guide/operations/graceful-shutdown.adoc b/docs/modules/superset/pages/usage-guide/operations/graceful-shutdown.adoc index 9faefede..a3f7d8d2 100644 --- a/docs/modules/superset/pages/usage-guide/operations/graceful-shutdown.adoc +++ b/docs/modules/superset/pages/usage-guide/operations/graceful-shutdown.adoc @@ -1,4 +1,5 @@ = Graceful shutdown +:description: Graceful shutdown of Apache Superset nodes, covering the configurable shutdown timeout and how the Superset process stops. You can configure the graceful shutdown as described in xref:concepts:operations/graceful_shutdown.adoc[]. diff --git a/docs/modules/superset/pages/usage-guide/operations/index.adoc b/docs/modules/superset/pages/usage-guide/operations/index.adoc index 21d170f9..f2f6a8ac 100644 --- a/docs/modules/superset/pages/usage-guide/operations/index.adoc +++ b/docs/modules/superset/pages/usage-guide/operations/index.adoc @@ -1,4 +1,5 @@ = Operations +:description: Operating Apache Superset with the Stackable operator, covering graceful shutdown, Pod disruptions, Pod placement and cluster operations. This section of the documentation is intended for the operations teams that maintain a Stackable Data Platform installation. diff --git a/docs/modules/superset/pages/usage-guide/operations/pod-disruptions.adoc b/docs/modules/superset/pages/usage-guide/operations/pod-disruptions.adoc index 70e2139b..0763352c 100644 --- a/docs/modules/superset/pages/usage-guide/operations/pod-disruptions.adoc +++ b/docs/modules/superset/pages/usage-guide/operations/pod-disruptions.adoc @@ -1,4 +1,5 @@ = Allowed Pod disruptions +:description: The PodDisruptionBudget the Stackable operator writes for Apache Superset nodes, and how to disable it. You can configure the permitted Pod disruptions for Superset nodes as described in xref:concepts:operations/pod_disruptions.adoc[]. diff --git a/docs/modules/superset/pages/usage-guide/operations/pod-placement.adoc b/docs/modules/superset/pages/usage-guide/operations/pod-placement.adoc index bd606026..62b5e72a 100644 --- a/docs/modules/superset/pages/usage-guide/operations/pod-placement.adoc +++ b/docs/modules/superset/pages/usage-guide/operations/pod-placement.adoc @@ -1,4 +1,5 @@ = Pod Placement +:description: Pod placement for Apache Superset, covering the default affinities and placement next to OPA when role mapping from OPA is configured. You can configure the Pod placement of the Superset pods as described in xref:concepts:operations/pod_placement.adoc[]. From 807267b85b4b4bdc0a532eafbf4e772cb9ce8975 Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Thu, 5 Nov 2026 13:25:15 +0100 Subject: [PATCH 2/2] docs: Include the resource requests partial --- .../pages/usage-guide/storage-resource-configuration.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/superset/pages/usage-guide/storage-resource-configuration.adoc b/docs/modules/superset/pages/usage-guide/storage-resource-configuration.adoc index 5e1e1d35..9244f38a 100644 --- a/docs/modules/superset/pages/usage-guide/storage-resource-configuration.adoc +++ b/docs/modules/superset/pages/usage-guide/storage-resource-configuration.adoc @@ -3,7 +3,7 @@ == Resource Requests -include::concepts:stackable_resource_requests.adoc[] +include::concepts:partial$stackable_resource_requests.adoc[] A minimal HA setup consisting of 2 Superset instances has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements]: