feat(docs): Add reference documentation (#433)

* WIP

* some fixes

Author: fhennig

docs/modules/hbase/pages/configuration.adoc

@@ -32,7 +32,7 @@ Role and RoleGroup the Operator creates a **Service**.
 A **ConfigMap** is created for each RoleGroup containing 3 files: `hbase-env.sh` and `hbase-site.xml` files generated
 from the HbaseCluster configuration (See xref:usage-guide/index.adoc[] for more information), plus a `log4j.properties`
 file used for xref:usage-guide/logging.adoc[]. The Operator creates a
-**xref:usage-guide/discovery.adoc[discovery ConfigMap]** for the whole HbaseCluster a which contains information on how
+**xref:reference/discovery.adoc[discovery ConfigMap]** for the whole HbaseCluster a which contains information on how
 to connect to the HBase cluster.
 
 == Dependencies

docs/modules/hbase/pages/index.adoc

@@ -1,5 +1,8 @@
+= Command Line Parameters
 
-=== product-config
+This operator accepts the following command line parameters:
+
+== product-config
 
 *Default value*: `/etc/stackable/hbase-operator/config-spec/properties.yaml`
 
@@ -12,7 +15,7 @@
 stackable-hbase-operator run --product-config /foo/bar/properties.yaml
 ----
 
-=== watch-namespace
+== watch-namespace
 
 *Default value*: All namespaces
 

docs/modules/hbase/pages/commandline_args.adoc renamed to docs/modules/hbase/pages/reference/commandline-parameters.adoc

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

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

@@ -1,5 +1,8 @@
+= Environment variables
 
-=== PRODUCT_CONFIG
+This operator accepts the following environment variables:
+
+== PRODUCT_CONFIG
 
 *Default value*: `/etc/stackable/hbase-operator/config-spec/properties.yaml`
 
@@ -25,7 +28,7 @@ docker run \
     docker.stackable.tech/stackable/hbase-operator:latest
 ----
 
-=== WATCH_NAMESPACE
+== WATCH_NAMESPACE
 
 *Default value*: All namespaces
 

docs/modules/hbase/pages/usage-guide/discovery.adoc renamed to docs/modules/hbase/pages/reference/discovery.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/hbase/pages/env_var_args.adoc renamed to docs/modules/hbase/pages/reference/environment-variables.adoc

@@ -6,4 +6,4 @@ Learn about xref:usage-guide/operations/pod-placement.adoc[configuring where Pod
 
 You can observe what's happening with your HBase using xref:usage-guide/logging.adoc[logging] and xref:usage-guide/monitoring.adoc[monitoring].
 
-Connect to HBase using xref:usage-guide/phoenix.adoc[Apache Phoenix] or use the xref:usage-guide/discovery.adoc[discovery ConfigMap] to connect other products.
+Connect to HBase using xref:usage-guide/phoenix.adoc[Apache Phoenix].

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

@@ -1,13 +1,11 @@
 * xref:hbase:getting_started/index.adoc[]
 ** xref:hbase:getting_started/installation.adoc[]
 ** xref:hbase:getting_started/first_steps.adoc[]
-* xref:hbase:configuration.adoc[]
 * xref:hbase:usage-guide/index.adoc[]
 ** xref:hbase:usage-guide/listenerclass.adoc[]
 ** xref:hbase:usage-guide/resource-requests.adoc[]
 ** xref:hbase:usage-guide/phoenix.adoc[]
 ** xref:hbase:usage-guide/compression.adoc[]
-** xref:hbase:usage-guide/discovery.adoc[]
 ** xref:hbase:usage-guide/logging.adoc[]
 ** xref:hbase:usage-guide/monitoring.adoc[]
 ** xref:hbase:usage-guide/overrides.adoc[]
@@ -16,3 +14,9 @@
 *** xref:hbase:usage-guide/operations/pod-placement.adoc[]
 *** xref:hbase:usage-guide/operations/pod-disruptions.adoc[]
 *** xref:hbase:usage-guide/operations/graceful-shutdown.adoc[]
+* xref:hbase:reference/index.adoc[]
+** xref:hbase:reference/crds.adoc[]
+*** {crd-docs}/hbase.stackable.tech/hbasecluster/v1alpha1/[HbaseCluster {external-link-icon}^]
+** xref:hbase:reference/discovery.adoc[]
+** xref:hbase:reference/commandline-parameters.adoc[]
+** xref:hbase:reference/environment-variables.adoc[]