stackabletech · fhennig · May 3, 2022 · Apr 25, 2022 · Apr 25, 2022 · Apr 26, 2022
diff --git a/antora.yml b/antora.yml
@@ -4,4 +4,5 @@ title: Stackable Documentation
 nav:
   - modules/ROOT/nav.adoc
   - modules/tutorials/nav.adoc
+  - modules/operators/nav.adoc
   - modules/contributor/nav.adoc
diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc
@@ -1,3 +1 @@
-* xref:getting_started.adoc[]
-* xref:supported-versions.adoc[]
-* xref:monitoring.adoc[]
+* xref:getting_started.adoc[]
diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc
@@ -20,10 +20,12 @@ This documentation gives you an overview of the Stackable Data Platform, how to
 <h3>Introduction</h3>
 ++++
 
-If you have any feedback regarding the documentation please either open an https://github.com/stackabletech/documentation/issues[issue], ask a https://github.com/stackabletech/documentation/discussions[question] or look at the source for this documentation in its https://github.com/stackabletech/documentation[repository].
-
 The Stackable Data Platform allows you to deploy, scale and manage Data infrastructure in any environment running https://kubernetes.io/[Kubernetes].
 
+You can find an overview of the supported components <<Components,below>>, as we as a full list of all supported product versions xref:operators:supported_versions.adoc[here].
+
+If you have any feedback regarding the documentation please either open an https://github.com/stackabletech/documentation/issues[issue], ask a https://github.com/stackabletech/documentation/discussions[question] or look at the source for this documentation in its https://github.com/stackabletech/documentation[repository].
+
 ++++
 </div>
 ++++

diff --git a/modules/contributor/nav.adoc b/modules/contributor/nav.adoc
@@ -1,6 +1,5 @@
-* Contributor's Guide
+* xref:index.adoc[]
 
-** xref:contribution_guide.adoc[]
 ** xref:steps.adoc[]
 ** xref:development_dashboard.adoc[]
 ** xref:service_discovery.adoc[]

diff --git a/modules/contributor/pages/adr/ADR015_definition_of_s3_objects.adoc b/modules/contributor/pages/adr/ADR015_definition_of_s3_objects.adoc
@@ -1,4 +1,4 @@
-= Representation of S3 Buckets in CRDs
+= ADR015: Representation of S3 Buckets in CRDs
 Sönke Liebau <[email protected]>
 v0.1, 29.04.2022
 :status: accepted

diff --git a/modules/contributor/pages/adr/index.adoc b/modules/contributor/pages/adr/index.adoc
@@ -0,0 +1,5 @@
+# Architectural Decision Records
+
+This section contains a decision log on architectural decisions in the form of architectural decision records (ADRs). Find the list of below:
+
+include::partial$current_adrs.adoc[]
diff --git a/...contributor/pages/contribution_guide.adoc → modules/contributor/pages/index.adoc b/...contributor/pages/contribution_guide.adoc → modules/contributor/pages/index.adoc
@@ -1,6 +1,4 @@
-= Overview
-
-== Introduction
+= Contributor's Guide
 
 Welcome to Stackable!
 
@@ -12,7 +10,6 @@ This document aims at getting your contribution posted as soon as possible.
 
 The development of the Stackable Platform takes place on https://github.com/stackabletech[GitHub]. On GitHub, each repository has its own issue tracker and since Stackable is a platform, there are several repositories where issues and pull-requests can be created. If you already have a good idea where the issue or pull-request belongs, then you can skip reading to the contribution steps below. Otherwise, you might want to a have a look at the xref:development_dashboard.adoc[] for hints.
 
-
 Contribution steps:
 
 1. Lookup if an existing issue already covers your problem

diff --git a/modules/contributor/pages/steps.adoc b/modules/contributor/pages/steps.adoc
@@ -73,5 +73,5 @@ helm install <operator> deploy/helm/<operator>/
     * Add references to other pull requests, like the pull request in the integration-tests repository which contains test cases for the change in the operator pull request.
     * Select a reviewer. Usually "stackabletech/developers" is a good choice.
     * If you are an internal contributor then assign yourself to the issue.
-2. All pull requests must pass a quality gate before they can be merged. This gate consists of required and not strictly required checks which are performed by automated GitHub checks, as well as the mentioned checklist which is checked manually in the review. The number of checks seems to be overwhelming but in practice they can be quite easily fulfilled if following this guide. A properly set-up development environment (see xref:contribution_guide.adoc#_development_environment[Development Environment]) makes it even easier because the most critical steps are performed automatically like showing Clippy warnings while developing and formatting the code. Have a look at the status of the checks after they are processed and fix them. The `reviewdog` checks are not mandatory and can be ignored if the according change was intentionally. For instance, if a Kubernetes secret was added to the examples of an operator then the `detect-secrets` steps could fail which is okay in this case.
+2. All pull requests must pass a quality gate before they can be merged. This gate consists of required and not strictly required checks which are performed by automated GitHub checks, as well as the mentioned checklist which is checked manually in the review. The number of checks seems to be overwhelming but in practice they can be quite easily fulfilled if following this guide. A properly set-up development environment (see xref:index.adoc#_development_environment[Development Environment]) makes it even easier because the most critical steps are performed automatically like showing Clippy warnings while developing and formatting the code. Have a look at the status of the checks after they are processed and fix them. The `reviewdog` checks are not mandatory and can be ignored if the according change was intentionally. For instance, if a Kubernetes secret was added to the examples of an operator then the `detect-secrets` steps could fail which is okay in this case.
 3. After the pull request is approved, it can be merged. Internal contributors merge them on their own. Pull request from external contributors are merged by the approver.
diff --git a/modules/contributor/partials/adr-nav.adoc b/modules/contributor/partials/adr-nav.adoc
@@ -1,20 +1,6 @@
-** Architectural Decision Records
+** xref:adr/index.adoc[]
 *** Current
-**** xref:adr/ADR001-choose_project_language.adoc[]
-**** xref:adr/ADR002-choose_repository_structure.adoc[]
-**** xref:adr/ADR003-choose_review_mechanism.adoc[]
-**** xref:adr/ADR004-choose_agent_programming_language.adoc[]
-**** xref:adr/ADR005-systemd_unit_file_location.adoc[]
-**** xref:adr/ADR007-defined_reuse_of_k8s.adoc[]
-**** xref:adr/ADR008-decide_reuse_of_operators.adoc[]
-**** xref:adr/ADR009-selector_support.adoc[]
-**** xref:adr/ADR010-command_pattern.adoc[]
-**** xref:adr/ADR011-directory_structure.adoc[]
-**** xref:adr/ADR012-authn_token_management.adoc[]
-**** xref:adr/ADR013-user_authentication_for_products.adoc[]
-**** xref:adr/ARD014-using_values_from_configmaps.adoc[]
-**** xref:adr/ADR015_definition_of_s3_objects.adoc[]
-*
+include::partial$current_adrs.adoc[]
 *** Deprecated
 **** xref:adr/deprecated/ADR006-choose_orchestrator_storage_backend.adoc[]
 *

diff --git a/modules/contributor/partials/current_adrs.adoc b/modules/contributor/partials/current_adrs.adoc
@@ -0,0 +1,14 @@
+**** xref:adr/ADR001-choose_project_language.adoc[]
+**** xref:adr/ADR002-choose_repository_structure.adoc[]
+**** xref:adr/ADR003-choose_review_mechanism.adoc[]
+**** xref:adr/ADR004-choose_agent_programming_language.adoc[]
+**** xref:adr/ADR005-systemd_unit_file_location.adoc[]
+**** xref:adr/ADR007-defined_reuse_of_k8s.adoc[]
+**** xref:adr/ADR008-decide_reuse_of_operators.adoc[]
+**** xref:adr/ADR009-selector_support.adoc[]
+**** xref:adr/ADR010-command_pattern.adoc[]
+**** xref:adr/ADR011-directory_structure.adoc[]
+**** xref:adr/ADR012-authn_token_management.adoc[]
+**** xref:adr/ADR013-user_authentication_for_products.adoc[]
+**** xref:adr/ARD014-using_values_from_configmaps.adoc[]
+**** xref:adr/ADR015_definition_of_s3_objects.adoc[]
diff --git a/...T/examples/monitoring-servicemonitor.yaml → ...s/examples/monitoring-servicemonitor.yaml b/...T/examples/monitoring-servicemonitor.yaml → ...s/examples/monitoring-servicemonitor.yaml
diff --git a/modules/operators/nav.adoc b/modules/operators/nav.adoc
@@ -0,0 +1,4 @@
+* xref:index.adoc[]
+** xref:supported_versions.adoc[]
+** xref:monitoring.adoc[]
+include::partial$operator_doc_links.adoc[]
diff --git a/modules/operators/pages/index.adoc b/modules/operators/pages/index.adoc
@@ -0,0 +1,8 @@
+# Operators
+
+This section of the Stackable documentation contains information about the individual Operators, as well as related information such as an overview over the xref:supported_versions.adoc[supported product versions] and how to enable xref:monitoring.adoc[monitoring] in all Operators.
+
+
+Find a list of all Operators below:
+
+include::partial$operator_doc_links.adoc[]
diff --git a/modules/ROOT/pages/monitoring.adoc → modules/operators/pages/monitoring.adoc b/modules/ROOT/pages/monitoring.adoc → modules/operators/pages/monitoring.adoc
diff --git a/modules/ROOT/pages/supported-versions.adoc → ...s/operators/pages/supported_versions.adoc b/modules/ROOT/pages/supported-versions.adoc → ...s/operators/pages/supported_versions.adoc
diff --git a/modules/operators/partials/operator_doc_links.adoc b/modules/operators/partials/operator_doc_links.adoc
@@ -0,0 +1,15 @@
+** xref:airflow::index.adoc[Apache Airflow]
+** xref:druid::index.adoc[Apache Druid]
+** xref:hbase::index.adoc[Apache HBase]
+** xref:hdfs::index.adoc[Apache Hadoop HDFS]
+** xref:hive::index.adoc[Apache Hive]
+** xref:kafka::index.adoc[Apache Kafka]
+** xref:nifi::index.adoc[Apache NiFi]
+** xref:spark::index.adoc[Apache Spark (standalone)]
+** xref:spark-k8s::index.adoc[Apache Spark on K8S]
+** xref:superset::index.adoc[Apache Superset]
+** xref:trino::index.adoc[Trino]
+** xref:zookeeper::index.adoc[Apache ZooKeeper]
+** xref:opa::index.adoc[OpenPolicyAgent]
+** xref:commons-operator::index.adoc[Commons]
+** xref:secret-operator::index.adoc[Secret]
diff --git a/supplemental-ui/partials/navbar.hbs b/supplemental-ui/partials/navbar.hbs
@@ -1,10 +1,10 @@
-<a class="navbar-sub-item" href="{{{ relativize "/home/index.html" }}}">Overview</a>
-<a class="navbar-sub-item" href="{{{ relativize "/home/index.html" }}}">Architecture</a>
+<a class="navbar-sub-item" href="{{{ relativize "/home/index.html" }}}">Home</a>
 <a class="navbar-sub-item" href="{{{ relativize "/home/getting_started.html" }}}">Getting Started</a>
 <a class="navbar-sub-item" href="{{{ relativize "/home/tutorials/end-to-end_data_pipeline_example.html" }}}">Tutorials</a>
 <div class="navbar-sub-item drop-down">
     Operators
     <div class="drop-down-content">
+    <a class="drop-down-item" href="{{{ relativize "/home/operators/index.html" }}}">Overview</a>
     <a class="drop-down-item" href="{{{ relativize "/airflow/index.html" }}}">Apache Airflow</a>
     <a class="drop-down-item" href="{{{ relativize "/druid/index.html" }}}">Apache Druid</a>
     <a class="drop-down-item" href="{{{ relativize "/hbase/index.html" }}}">Apache HBase</a>
@@ -22,3 +22,4 @@
     <a class="drop-down-item" href="{{{ relativize "/secret-operator/index.html" }}}">Secret</a>
     </div>
 </div>
+<a class="navbar-sub-item" href="{{{ relativize "/home/contributor/index.html" }}}">Contribute</a>