stackabletech · fhennig · Feb 6, 2023 · Feb 6, 2023 · Feb 7, 2023 · Feb 13, 2023
diff --git a/docs/antora.yml b/docs/antora.yml
@@ -1,7 +1,3 @@
-name: hbase
+---
+name: home
 version: "nightly"
-title: Stackable Operator for Apache HBase
-nav:
-  - modules/getting_started/nav.adoc
-  - modules/ROOT/nav.adoc
-prerelease: true
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
diff --git a/docs/modules/getting_started/nav.adoc b/docs/modules/getting_started/nav.adoc
diff --git a/..._started/examples/code/getting_started.sh → ...amples/getting_started/getting_started.sh b/..._started/examples/code/getting_started.sh → ...amples/getting_started/getting_started.sh
diff --git a/...arted/examples/code/getting_started.sh.j2 → ...les/getting_started/getting_started.sh.j2 b/...arted/examples/code/getting_started.sh.j2 → ...les/getting_started/getting_started.sh.j2
diff --git a/.../getting_started/examples/code/hbase.yaml → ...hbase/examples/getting_started/hbase.yaml b/.../getting_started/examples/code/hbase.yaml → ...hbase/examples/getting_started/hbase.yaml
diff --git a/...s/getting_started/examples/code/hdfs.yaml → .../hbase/examples/getting_started/hdfs.yaml b/...s/getting_started/examples/code/hdfs.yaml → .../hbase/examples/getting_started/hdfs.yaml
diff --git a/..._started/examples/code/install_output.txt → ...amples/getting_started/install_output.txt b/..._started/examples/code/install_output.txt → ...amples/getting_started/install_output.txt
diff --git a/...arted/examples/code/install_output.txt.j2 → ...les/getting_started/install_output.txt.j2 b/...arted/examples/code/install_output.txt.j2 → ...les/getting_started/install_output.txt.j2
diff --git a/...xamples/code/test_getting_started_helm.sh → ...ting_started/test_getting_started_helm.sh b/...xamples/code/test_getting_started_helm.sh → ...ting_started/test_getting_started_helm.sh
diff --git a/...code/test_getting_started_stackablectl.sh → ...rted/test_getting_started_stackablectl.sh b/...code/test_getting_started_stackablectl.sh → ...rted/test_getting_started_stackablectl.sh
diff --git a/...les/getting_started/examples/code/zk.yaml → ...es/hbase/examples/getting_started/zk.yaml b/...les/getting_started/examples/code/zk.yaml → ...es/hbase/examples/getting_started/zk.yaml
diff --git a/.../getting_started/examples/code/znode.yaml → ...hbase/examples/getting_started/znode.yaml b/.../getting_started/examples/code/znode.yaml → ...hbase/examples/getting_started/znode.yaml
diff --git a/docs/modules/ROOT/images/phoenix_sqlline.png → .../modules/hbase/images/phoenix_sqlline.png b/docs/modules/ROOT/images/phoenix_sqlline.png → .../modules/hbase/images/phoenix_sqlline.png
diff --git a/docs/modules/ROOT/images/phoenix_tables.png → docs/modules/hbase/images/phoenix_tables.png b/docs/modules/ROOT/images/phoenix_tables.png → docs/modules/hbase/images/phoenix_tables.png
diff --git a/.../modules/ROOT/pages/commandline_args.adoc → ...modules/hbase/pages/commandline_args.adoc b/.../modules/ROOT/pages/commandline_args.adoc → ...modules/hbase/pages/commandline_args.adoc
diff --git a/docs/modules/ROOT/pages/configuration.adoc → docs/modules/hbase/pages/configuration.adoc b/docs/modules/ROOT/pages/configuration.adoc → docs/modules/hbase/pages/configuration.adoc
diff --git a/docs/modules/ROOT/pages/discovery.adoc → docs/modules/hbase/pages/discovery.adoc b/docs/modules/ROOT/pages/discovery.adoc → docs/modules/hbase/pages/discovery.adoc
diff --git a/docs/modules/ROOT/pages/env_var_args.adoc → docs/modules/hbase/pages/env_var_args.adoc b/docs/modules/ROOT/pages/env_var_args.adoc → docs/modules/hbase/pages/env_var_args.adoc
diff --git a/...es/getting_started/pages/first_steps.adoc → ...se/pages/getting_started/first_steps.adoc b/...es/getting_started/pages/first_steps.adoc → ...se/pages/getting_started/first_steps.adoc
@@ -1,6 +1,6 @@
 = First steps
 
-Once you have followed the steps in the xref:installation.adoc[] section to install the operator and its dependencies, you will now deploy an HBase cluster and its dependencies. Afterwards you can <<_verify_that_it_works, verify that it works>> by creating tables and data in HBase using the REST API and Apache Phoenix (an SQL layer used to interact with HBase).
+Once you have followed the steps in the xref:getting_started/installation.adoc[] section to install the operator and its dependencies, you will now deploy an HBase cluster and its dependencies. Afterwards you can <<_verify_that_it_works, verify that it works>> by creating tables and data in HBase using the REST API and Apache Phoenix (an SQL layer used to interact with HBase).
 
 == Setup
 
@@ -9,30 +9,30 @@ Once you have followed the steps in the xref:installation.adoc[] section to inst
 To deploy a ZooKeeper cluster create one file called `zk.yaml`:
 
 [source,yaml]
-include::example$code/zk.yaml[]
+include::example$getting_started/zk.yaml[]
 
 We also need to define a ZNode that will be used by the HDFS and HBase clusters to reference ZooKeeper. Create another file called `znode.yaml`:
 
 [source,yaml]
-include::example$code/znode.yaml[]
+include::example$getting_started/znode.yaml[]
 
 Apply both of these files:
 
 [source]
-include::example$code/getting_started.sh[tag=install-zk]
+include::example$getting_started/getting_started.sh[tag=install-zk]
 
 The state of the ZooKeeper cluster can be tracked with `kubectl`:
 
 [source]
-include::example$code/getting_started.sh[tag=watch-zk-rollout]
+include::example$getting_started/getting_started.sh[tag=watch-zk-rollout]
 
 === HDFS
 
 An HDFS cluster has three components: the `namenode`, the `datanode` and the `journalnode`. Create a file named `hdfs.yaml` defining 2 `namenodes` and one `datanode` and `journalnode` each:
 
 [source,yaml]
 ----
-include::example$code/hdfs.yaml[]
+include::example$getting_started/hdfs.yaml[]
 ----
 
 Where:
@@ -47,21 +47,21 @@ It should generally be safe to simply use the latest image version that is avail
 Create the actual HDFS cluster by applying the file:
 
 ----
-include::example$code/getting_started.sh[tag=install-hdfs]
+include::example$getting_started/getting_started.sh[tag=install-hdfs]
 ----
 
 Track the progress with `kubectl` as this step may take a few minutes:
 
 [source]
-include::example$code/getting_started.sh[tag=watch-hdfs-rollout]
+include::example$getting_started/getting_started.sh[tag=watch-hdfs-rollout]
 
 === HBase
 
 You can now create the HBase cluster. Create a file called `hbase.yaml` containing the following:
 
 [source,yaml]
 ----
-include::example$code/hbase.yaml[]
+include::example$getting_started/hbase.yaml[]
 ----
 
 == Verify that it works
@@ -71,7 +71,7 @@ To test the cluster you will use the REST API to check its version and status, a
 First, check the cluster version with this callout:
 
 [source]
-include::example$code/getting_started.sh[tag=cluster-version]
+include::example$getting_started/getting_started.sh[tag=cluster-version]
 
 This will return the version that was specified in the HBase cluster definition:
 
@@ -81,7 +81,7 @@ This will return the version that was specified in the HBase cluster definition:
 The cluster status can be checked and formatted like this:
 
 [source]
-include::example$code/getting_started.sh[tag=cluster-status]
+include::example$getting_started/getting_started.sh[tag=cluster-status]
 
 which will display cluster metadata that looks like this (only the first region is included for the sake of readability):
 
@@ -123,12 +123,12 @@ which will display cluster metadata that looks like this (only the first region
 You can now create a table like this:
 
 [source]
-include::example$code/getting_started.sh[tag=create-table]
+include::example$getting_started/getting_started.sh[tag=create-table]
 
 This will create a table `users` with a single column family `cf`. Its creation can be verified by listing it:
 
 [source]
-include::example$code/getting_started.sh[tag=get-table]
+include::example$getting_started/getting_started.sh[tag=get-table]
 
 [source,json]
 {
@@ -142,7 +142,7 @@ include::example$code/getting_started.sh[tag=get-table]
 An alternative way to interact with HBase is to use the https://phoenix.apache.org/index.html[Phoenix] library that is pre-installed on the Stackable HBase image (in the /stackable/phoenix directory). Use the python utility `psql.py` (found in /stackable/phoenix/bin) to create, populate and query a table called `WEB_STAT`:
 
 [source]
-include::example$code/getting_started.sh[tag=phoenix-table]
+include::example$getting_started/getting_started.sh[tag=phoenix-table]
 
 The final command will display some grouped data like this:
 
@@ -156,7 +156,7 @@ Time: 0.017 sec(s)
 Check the tables again with:
 
 [source]
-include::example$code/getting_started.sh[tag=get-table]
+include::example$getting_started/getting_started.sh[tag=get-table]
 
 This time the list includes not just `users` (created above with the REST API) and `WEB_STAT`, but several other tables too:
 
@@ -200,4 +200,4 @@ This is because Phoenix requires these `SYSTEM.` tables for its own internal map
 
 == What's next
 
-Look at the xref:ROOT:usage.adoc[Usage page] to find out more about configuring your HBase cluster.
+Look at the xref:usage.adoc[Usage page] to find out more about configuring your HBase cluster.
diff --git a/.../modules/getting_started/pages/index.adoc → ...es/hbase/pages/getting_started/index.adoc b/.../modules/getting_started/pages/index.adoc → ...es/hbase/pages/getting_started/index.adoc
@@ -20,5 +20,5 @@ Resource sizing depends on cluster type(s), usage and scope, but as a starting p
 
 The Guide is divided into two steps:
 
-* xref:installation.adoc[Installing the Operators].
-* xref:first_steps.adoc[Setting up the HBase cluster and verifying it works].
+* xref:getting_started/installation.adoc[Installing the Operators].
+* xref:getting_started/first_steps.adoc[Setting up the HBase cluster and verifying it works].
diff --git a/...s/getting_started/pages/installation.adoc → ...e/pages/getting_started/installation.adoc b/...s/getting_started/pages/installation.adoc → ...e/pages/getting_started/installation.adoc
@@ -19,13 +19,13 @@ After you have installed stackablectl run the following command to install all o
 
 [source,bash]
 ----
-include::example$code/getting_started.sh[tag=stackablectl-install-operators]
+include::example$getting_started/getting_started.sh[tag=stackablectl-install-operators]
 ----
 
 The tool will show
 
 [source]
-include::example$code/install_output.txt[]
+include::example$getting_started/install_output.txt[]
 
 
 TIP: Consult the xref:stackablectl::quickstart.adoc[] to learn more about how to use stackablectl. For example, you can use the `-k` flag to create a Kubernetes cluster with link:https://kind.sigs.k8s.io/[kind].
@@ -35,17 +35,17 @@ TIP: Consult the xref:stackablectl::quickstart.adoc[] to learn more about how to
 You can also use Helm to install the operators. Add the Stackable Helm repository:
 [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 HBase cluster (as well as the CRDs for the required operators). You are now ready to deploy HBase in Kubernetes.
 
 == What's next
 
-xref:first_steps.adoc[Set up an HBase cluster] and its dependencies and xref:first_steps.adoc#_verify_that_it_works[verify that it works].
+xref:getting_started/first_steps.adoc[Set up an HBase cluster] and its dependencies and xref:getting_started/first_steps.adoc#_verify_that_it_works[verify that it works].
diff --git a/docs/modules/ROOT/pages/index.adoc → docs/modules/hbase/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc → docs/modules/hbase/pages/index.adoc
diff --git a/docs/modules/ROOT/pages/usage.adoc → docs/modules/hbase/pages/usage.adoc b/docs/modules/ROOT/pages/usage.adoc → docs/modules/hbase/pages/usage.adoc
diff --git a/docs/modules/hbase/partials/nav.adoc b/docs/modules/hbase/partials/nav.adoc
@@ -0,0 +1,6 @@
+* 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.adoc[]
+* xref:hbase:discovery.adoc[]
diff --git a/...les/ROOT/partials/supported-versions.adoc → ...es/hbase/partials/supported-versions.adoc b/...les/ROOT/partials/supported-versions.adoc → ...es/hbase/partials/supported-versions.adoc