Spike/distributed component (#424)

# Description

*Please add a description here. This will become the commit message of the merge request later.*

Author: Felix Hennig

docs/antora.yml

@@ -1,8 +1,3 @@
-name: nifi
+---
+name: home
 version: "nightly"
-title: Stackable Operator for Apache NiFi
-nav:
-  - modules/getting_started/nav.adoc
-  - modules/ROOT/nav.adoc
-  - modules/usage_guide/nav.adoc
-prerelease: true

docs/modules/ROOT/nav.adoc

@@ -1,6 +1,6 @@
 = First steps
 
-After going through the xref:installation.adoc[] section and having installed all the operators, you will now deploy a NiFi cluster and the required dependencies. Afterwards you can <<_verify_that_it_works, verify that it works>> by querying the REST API.
+After going through the xref:getting_started/installation.adoc[] section and having installed all the operators, you will now deploy a NiFi cluster and the required dependencies. Afterwards you can <<_verify_that_it_works, verify that it works>> by querying the REST API.
 
 == Setup
 
@@ -17,32 +17,32 @@ To create a ZooKeeper instance run the following command:
 
 [source,bash]
 ----
-include::example$code/getting-started.sh[tag=install-zookeeper]
+include::example$getting_started/getting-started.sh[tag=install-zookeeper]
 ----
 
 Create a Znode object:
 
 [source,bash]
 ----
-include::example$code/getting-started.sh[tag=install-znode]
+include::example$getting_started/getting-started.sh[tag=install-znode]
 ----
 
-The xref:zookeeper:ROOT:znodes.adoc[ZNode] makes sure that the NiFi cluster will operate in its own separated directory in ZooKeeper.
+The xref:zookeeper:znodes.adoc[ZNode] makes sure that the NiFi cluster will operate in its own separated directory in ZooKeeper.
 
 === Apache NiFi
 
 The NiFi cluster requires authentication. Create a set of credentials for this purpose:
 
 [source,bash]
 ----
-include::example$code/getting-started.sh[tag=install-nifi-credentials]
+include::example$getting_started/getting-started.sh[tag=install-nifi-credentials]
 ----
 
 Finally create a NiFi instance:
 
 [source,bash]
 ----
-include::example$code/getting-started.sh[tag=install-nifi]
+include::example$getting_started/getting-started.sh[tag=install-nifi]
 ----
 
 == Verify that it works
@@ -51,7 +51,7 @@ First, make sure all pods are ready:
 
 [source,bash]
 ----
-include::example$code/getting-started.sh[tag=wait-nifi-rollout]
+include::example$getting_started/getting-started.sh[tag=wait-nifi-rollout]
 ----
 
 Then make sure the StatefulSets are ready:
@@ -105,7 +105,7 @@ Extracting the IP and port via `kubectl` is cumbersome. We recommend using `stac
 
 [source,bash]
 ----
-include::example$code/getting-started.sh[tag=get-nifi-node-name]
+include::example$getting_started/getting-started.sh[tag=get-nifi-node-name]
 ----
 
 which should output a single node name where a NiFi pod is scheduled:
@@ -119,7 +119,7 @@ Retrieve the IP of that node:
 
 [source,bash]
 ----
-include::example$code/getting-started.sh[tag=get-nifi-node-ip]
+include::example$getting_started/getting-started.sh[tag=get-nifi-node-ip]
 ----
 
 which should output the internal IP of that node:
@@ -133,7 +133,7 @@ Finally, retrieve the NodePort of the `simple-nifi` service:
 
 [source,bash]
 ----
-include::example$code/getting-started.sh[tag=get-nifi-service-port]
+include::example$getting_started/getting-started.sh[tag=get-nifi-service-port]
 ----
 
 which should output the NodePort:
@@ -147,7 +147,7 @@ Now build the full URL:
 
 [source,bash]
 ----
-include::example$code/getting-started.sh[tag=create_nifi_url]
+include::example$getting_started/getting-started.sh[tag=create_nifi_url]
 ----
 
 which should output a URL to connect to the NiFi web interface:
@@ -161,4 +161,4 @@ Then connect to `https://172.18.0.3:32595/nifi` and you should see the NiFi web
 
 == What's next
 
-Have a look at the xref:usage_guide:index.adoc[] page to find out more about the features of the NiFi Operator.
+Have a look at the xref:usage_guide/index.adoc[] page to find out more about the features of the NiFi Operator.

docs/modules/getting_started/nav.adoc

@@ -19,5 +19,5 @@ Resource sizing depends on cluster type(s), usage and scope, but as a starting p
 
 The guide is divided into the following steps:
 
-* xref:installation.adoc[Installing the Operators]
-* xref:first_steps.adoc[Setting up the NiFi cluster]
+* xref:getting_started/installation.adoc[Installing the Operators]
+* xref:getting_started/first_steps.adoc[Setting up the NiFi cluster]

docs/modules/getting_started/assets/images/nifi-web-ui.png docs/modules/nifi/assets/images/nifi-web-ui.png

@@ -19,14 +19,14 @@ running, run the following command to install all operators necessary for NiFi:
 
 [source,bash]
 ----
-include::example$code/getting-started.sh[tag=stackablectl-install-operators]
+include::example$getting_started/getting-started.sh[tag=stackablectl-install-operators]
 ----
 
 The output should contain the following lines
 
 [source]
 ----
-include::example$code/install-operator-output.txt[tag=stackablectl-install-operators-output]
+include::example$getting_started/install-operator-output.txt[tag=stackablectl-install-operators-output]
 ----
 
 TIP: Consult the xref:stackablectl::quickstart.adoc[] to learn more about how to use `stackablectl`.
@@ -37,18 +37,18 @@ You can also use Helm to install the operators. Add the Stackable Helm repositor
 
 [source,bash]
 ----
-include::example$code/getting-started.sh[tag=helm-add-repo]
+include::example$getting_started/getting-started.sh[tag=helm-add-repo]
 ----
 
 Then install the Stackable Operators:
 
 [source,bash]
 ----
-include::example$code/getting-started.sh[tag=helm-install-operators]
+include::example$getting_started/getting-started.sh[tag=helm-install-operators]
 ----
 
 Helm will deploy the operators in a Kubernetes Deployment and apply the CRDs for the Apache NiFi service (as well as the CRDs for the required operators). You are now ready to deploy Apache NiFi in Kubernetes.
 
 == What's next
 
-xref:first_steps.adoc[Setting up a NiFi cluster] and its dependencies.
+xref:getting_started/first_steps.adoc[Setting up a NiFi cluster] and its dependencies.

docs/modules/getting_started/examples/code/getting-started.sh docs/modules/nifi/examples/getting_started/getting-started.sh

@@ -1,3 +1,3 @@
 = Usage guide
 
-This section will help you to use various aspects of the Stackable Operator for Apache NiFi. For a general introduction into the operator follow the xref:getting_started:index.adoc[] guide.
+This section will help you to use various aspects of the Stackable Operator for Apache NiFi. For a general introduction into the operator follow the xref:getting_started/index.adoc[] guide.

docs/modules/getting_started/examples/code/getting-started.sh.j2 docs/modules/nifi/examples/getting_started/getting-started.sh.j2

@@ -0,0 +1,12 @@
+* xref:nifi:getting_started/index.adoc[]
+** xref:nifi:getting_started/installation.adoc[]
+** xref:nifi:getting_started/first_steps.adoc[]
+* xref:nifi:dependencies.adoc[]
+* xref:nifi:configuration.adoc[]
+* xref:nifi:usage_guide/index.adoc[]
+** xref:nifi:usage_guide/security.adoc[]
+** xref:nifi:usage_guide/resource-configuration.adoc[]
+** xref:nifi:usage_guide/monitoring.adoc[]
+** xref:nifi:usage_guide/log-aggregation.adoc[]
+** xref:nifi:usage_guide/configuration-environment-overrides.adoc[]
+** xref:nifi:usage_guide/updating.adoc[]