reference docs (#398)

docs/modules/hive/pages/commandline_args.adoc → docs/modules/hive/pages/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/hive-operator/config-spec/properties.yaml`
 
@@ -12,7 +15,7 @@
 stackable-hive-operator run --product-config /foo/bar/properties.yaml
 ----
 
-=== watch-namespace
+== watch-namespace
 
 *Default value*: All namespaces
 

docs/modules/hive/pages/reference/crds.adoc

@@ -0,0 +1,3 @@
+= CRD Reference
+
+Find all CRD reference for the Stackable Operator for Apache Hive at: {crd-docs-base-url}/hive-operator/{crd-docs-version}.

docs/modules/hive/pages/discovery.adoc → docs/modules/hive/pages/reference/discovery.adoc

@@ -2,10 +2,11 @@
 :namespace: \{namespace\}
 :metastorePort: 9083
 :roleGroup: \{roleGroup\}
+:page-aliases: discovery.adoc
 
 = Discovery
 
-The Stackable Operator for Apache Hive publishes a discovery https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#configmap-v1-core[`ConfigMap`], which exposes a client configuration bundle that allows access to the Apache Hive cluster.
+The Stackable Operator for Apache Hive publishes a discovery https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#configmap-v1-core[ConfigMap], which exposes a client configuration bundle that allows access to the Apache Hive cluster.
 
 The bundle includes an Apache Thrift connection string to access the Hive Metastore service. This string may be used by other operators or tools to configure their products with access to Hive. Access is limited to services within the same Kubernetes cluster.
 
@@ -32,17 +33,17 @@ spec:
       default: # <3>
         replicas: 2
 ----
-<1> The name of the Hive cluster, which is also the name of the created discovery `ConfigMap`.
-<2> The namespace of the discovery `ConfigMap`.
+<1> The name of the Hive cluster, which is also the name of the created discovery ConfigMap.
+<2> The namespace of the discovery ConfigMap.
 <3> A role group name of the metastore role.
 
-The resulting discovery `ConfigMap` is `{namespace}/{clusterName}`.
+The resulting discovery ConfigMap is `{namespace}/{clusterName}`.
 
 == Contents
 
 === Internal access
 
-The `{namespace}/{clusterName}` discovery `ConfigMap` contains the following fields where `{clusterName}` represents the name, `{namespace}` the namespace of the cluster and `{roleGroup}` a role group of the `metastore` role:
+The `{namespace}/{clusterName}` discovery ConfigMap contains the following fields where `{clusterName}` represents the name, `{namespace}` the namespace of the cluster and `{roleGroup}` a role group of the `metastore` role:
 
 `HIVE`::
 ====

docs/modules/hive/pages/env_var_args.adoc → docs/modules/hive/pages/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/hive-operator/config-spec/properties.yaml`
 
@@ -25,7 +28,7 @@ docker run \
     docker.stackable.tech/stackable/hive-operator:latest
 ----
 
-=== WATCH_NAMESPACE
+== WATCH_NAMESPACE
 
 *Default value*: All namespaces
 

docs/modules/hive/pages/reference/index.adoc

@@ -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.

docs/modules/hive/partials/nav.adoc

@@ -1,9 +1,6 @@
 * xref:hive:getting_started/index.adoc[]
 ** xref:hive:getting_started/installation.adoc[]
 ** xref:hive:getting_started/first_steps.adoc[]
-* xref:hive:configuration.adoc[]
-* Concepts
-** xref:hive:discovery.adoc[]
 * xref:hive:required-external-components.adoc[]
 * xref:hive:usage-guide/index.adoc[]
 ** xref:hive:usage-guide/listenerclass.adoc[]
@@ -17,3 +14,9 @@
 *** xref:hive:usage-guide/operations/pod-placement.adoc[]
 *** xref:hive:usage-guide/operations/pod-disruptions.adoc[]
 *** xref:hive:usage-guide/operations/graceful-shutdown.adoc[]
+* xref:hive:reference/index.adoc[]
+** xref:hive:reference/crds.adoc[]
+*** {crd-docs}/hive.stackable.tech/hivecluster/v1alpha1/[HiveCluster {external-link-icon}^]
+** xref:hive:reference/discovery.adoc[]
+** xref:hive:reference/commandline-parameters.adoc[]
+** xref:hive:reference/environment-variables.adoc[]