reference stuff

stackabletech · Dec 21, 2023 · e122bfb · e122bfb
1 parent 6550447
commit e122bfb
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 19 deletions.
diff --git a/docs/modules/trino/pages/configuration.adoc b/docs/modules/trino/pages/configuration.adoc
diff --git a/...modules/trino/pages/commandline_args.adoc → ...ges/reference/commandline-parameters.adoc b/...modules/trino/pages/commandline_args.adoc → ...ges/reference/commandline-parameters.adoc
@@ -1,5 +1,8 @@
+= Command line parameters
 
-=== product-config
+This operator accepts the following command line parameters:
+
+== product-config
 
 *Default value*: `/etc/stackable/trino-operator/config-spec/properties.yaml`
 
@@ -12,7 +15,7 @@
 cargo run -- run --product-config /foo/bar/properties.yaml
 ----
 
-=== watch-namespace
+== watch-namespace
 
 *Default value*: All namespaces
 

diff --git a/docs/modules/trino/pages/reference/crds.adoc b/docs/modules/trino/pages/reference/crds.adoc
@@ -0,0 +1,3 @@
+= CRD Reference
+
+Find all CRD reference for the Stackable Operator for Trino at: {crd-docs-base-url}/trino-operator/{crd-docs-version}.
diff --git a/docs/modules/trino/pages/env_var_args.adoc → ...ages/reference/environment-variables.adoc b/docs/modules/trino/pages/env_var_args.adoc → ...ages/reference/environment-variables.adoc
@@ -1,5 +1,8 @@
+= Environment variables
 
-=== PRODUCT_CONFIG
+This operator accepts the following environment variables:
+
+== PRODUCT_CONFIG
 
 *Default value*: `/etc/stackable/trino-operator/config-spec/properties.yaml`
 
@@ -25,7 +28,7 @@ docker run \
     docker.stackable.tech/stackable/trino-operator:latest
 ----
 
-=== WATCH_NAMESPACE
+== WATCH_NAMESPACE
 
 *Default value*: All namespaces
 
@@ -53,4 +56,3 @@ docker run \
 --mount type=bind,source="$HOME/.kube/config",target="/home/stackable/.kube/config" \
 docker.stackable.tech/stackable/trino-operator:latest
 ----
-
diff --git a/docs/modules/trino/pages/reference/index.adoc b/docs/modules/trino/pages/reference/index.adoc
@@ -0,0 +1,6 @@
+= 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 xref:reference/commandline-parameters.adoc[] and xref:reference/environment-variables.adoc[] accepted by the operator.
diff --git a/docs/modules/trino/partials/nav.adoc b/docs/modules/trino/partials/nav.adoc
@@ -1,7 +1,6 @@
 * xref:trino:getting_started/index.adoc[]
 ** xref:trino:getting_started/installation.adoc[]
 ** xref:trino:getting_started/first_steps.adoc[]
-* xref:trino:configuration.adoc[]
 * xref:trino:concepts.adoc[]
 * xref:trino:usage-guide/index.adoc[]
 ** xref:trino:usage-guide/connect_to_trino.adoc[]
@@ -25,3 +24,9 @@
 *** xref:trino:usage-guide/operations/pod-placement.adoc[]
 *** xref:trino:usage-guide/operations/pod-disruptions.adoc[]
 *** xref:trino:usage-guide/operations/graceful-shutdown.adoc[]
+* xref:trino:reference/index.adoc[]
+** xref:trino:reference/crds.adoc[]
+*** {crd-docs}/trino.stackable.tech/trinocluster/v1alpha1/[TrinoCluster {external-link-icon}^]
+*** {crd-docs}/trino.stackable.tech/trinocatalog/v1alpha1/[TrinoCatalog {external-link-icon}^]
+** xref:trino:reference/commandline-parameters.adoc[]
+** xref:trino:reference/environment-variables.adoc[]