feat(docs): Reference docs added (#546)

* reference stuff

* fixed link

Author: fhennig

docs/modules/nifi/pages/reference/commandline-parameters.adoc

@@ -0,0 +1,31 @@
+= Command Line parameters
+
+This operator accepts the following command line parameters:
+
+== product-config
+
+*Default value*: `/etc/stackable/nifi-operator/config-spec/properties.yaml`
+
+*Required*: false
+
+*Multiple values:* false
+
+[source]
+----
+stackable-nifi-operator run --product-config /foo/bar/properties.yaml
+----
+
+== watch-namespace
+
+*Default value*: All namespaces
+
+*Required*: false
+
+*Multiple values:* false
+
+The operator will **only** watch for resources in the provided namespace `test`:
+
+[source]
+----
+stackable-nifi-operator run --watch-namespace test
+----

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

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

docs/modules/nifi/pages/configuration.adoc renamed to docs/modules/nifi/pages/reference/environment-variables.adoc

@@ -1,42 +1,8 @@
-= Configuration
-
-== Command Line Parameters
-
-This operator accepts the following command line parameters:
-
-=== product-config
-
-*Default value*: `/etc/stackable/nifi-operator/config-spec/properties.yaml`
-
-*Required*: false
-
-*Multiple values:* false
-
-[source]
-----
-stackable-nifi-operator run --product-config /foo/bar/properties.yaml
-----
-
-=== watch-namespace
-
-*Default value*: All namespaces
-
-*Required*: false
-
-*Multiple values:* false
-
-The operator will **only** watch for resources in the provided namespace `test`:
-
-[source]
-----
-stackable-nifi-operator run --watch-namespace test
-----
-
-== Environment variables
+= Environment variables
 
 This operator accepts the following environment variables:
 
-=== PRODUCT_CONFIG
+== PRODUCT_CONFIG
 
 *Default value*: `/etc/stackable/nifi-operator/config-spec/properties.yaml`
 
@@ -62,7 +28,7 @@ docker run \
     docker.stackable.tech/stackable/nifi-operator:latest
 ----
 
-=== WATCH_NAMESPACE
+== WATCH_NAMESPACE
 
 *Default value*: All namespaces
 

docs/modules/nifi/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.

docs/modules/nifi/pages/usage_guide/security.adoc

@@ -55,7 +55,7 @@ spec:
 [#authentication-ldap]
 === LDAP
 
-NiFi supports xref:nightly@home:concepts:authentication.adoc[authentication] of users against an LDAP server. This requires setting up an xref:nightly@home:concepts:authentication.adoc#authenticationclass[AuthenticationClass] for the LDAP server.
+NiFi supports xref:home:concepts:authentication.adoc[authentication] of users against an LDAP server. This requires setting up an AuthenticationClass for the LDAP server.
 The AuthenticationClass is then referenced in the NifiCluster resource as follows:
 
 [source,yaml]
@@ -72,7 +72,7 @@ spec:
 
 <1> The reference to an AuthenticationClass called `ldap`
 
-You can follow the xref:nightly@home:tutorials:authentication_with_openldap.adoc[] tutorial to learn how to set up an AuthenticationClass for an LDAP server, as well as consulting the xref:nightly@home:reference:authenticationclass.adoc[] reference.
+You can follow the xref:home:tutorials:authentication_with_openldap.adoc[] tutorial to learn how to set up an AuthenticationClass for an LDAP server, as well as consulting the {crd-docs}/authentication.stackable.tech/authenticationclass/v1alpha1/[AuthenticationClass reference {external-link-icon}^].
 
 == Authorization
 

docs/modules/nifi/partials/nav.adoc

@@ -1,7 +1,6 @@
 * xref:nifi:getting_started/index.adoc[]
 ** xref:nifi:getting_started/installation.adoc[]
 ** xref:nifi:getting_started/first_steps.adoc[]
-* xref:nifi:configuration.adoc[]
 * xref:nifi:usage_guide/index.adoc[]
 ** xref:nifi:usage_guide/listenerclass.adoc[]
 ** xref:nifi:usage_guide/zookeeper-connection.adoc[]
@@ -19,3 +18,8 @@
 *** xref:nifi:usage_guide/operations/pod-placement.adoc[]
 *** xref:nifi:usage_guide/operations/pod-disruptions.adoc[]
 *** xref:nifi:usage_guide/operations/graceful-shutdown.adoc[]
+* xref:nifi:reference/index.adoc[]
+** xref:nifi:reference/crds.adoc[]
+*** {crd-docs}/nifi.stackable.tech/nificluster/v1alpha1/[NiFiCluster {external-link-icon}^]
+** xref:nifi:reference/commandline-parameters.adoc[]
+** xref:nifi:reference/environment-variables.adoc[]