crate · amotl · Oct 26, 2023 · Oct 26, 2023 · Oct 26, 2023
diff --git a/backlog.md b/backlog.md
@@ -0,0 +1,7 @@
+# Backlog
+
+- Add homepage with better guidance
+- Add content from `crate-tutorials` at `/install`
+- Add ML content from other patches and repositories
+- Link to tutorials in community forum
+- Backport high-quality content from community forum
diff --git a/docs/clustering/index.rst → docs/admin/clustering/index.rst b/docs/clustering/index.rst → docs/admin/clustering/index.rst
diff --git a/docs/clustering/kubernetes.rst → docs/admin/clustering/kubernetes.rst b/docs/clustering/kubernetes.rst → docs/admin/clustering/kubernetes.rst
diff --git a/.../clustering/logical-replication-setup.rst → .../clustering/logical-replication-setup.rst b/.../clustering/logical-replication-setup.rst → .../clustering/logical-replication-setup.rst
diff --git a/docs/clustering/multi-node-setup.rst → docs/admin/clustering/multi-node-setup.rst b/docs/clustering/multi-node-setup.rst → docs/admin/clustering/multi-node-setup.rst
@@ -150,7 +150,7 @@ instructions.
    verify that the cluster has auto-bootstrapped with three nodes. You should see
    something like this:
 
-   .. image:: ../_assets/img/multi-node-cluster.png
+   .. image:: /_assets/img/multi-node-cluster.png
       :alt: The CrateDB Admin UI showing a multi-node cluster
 
 

diff --git a/docs/clustering/multi-zone-setup.rst → docs/admin/clustering/multi-zone-setup.rst b/docs/clustering/multi-zone-setup.rst → docs/admin/clustering/multi-zone-setup.rst
diff --git a/docs/going-into-production.rst → docs/admin/going-into-production.rst b/docs/going-into-production.rst → docs/admin/going-into-production.rst
diff --git a/docs/admin/index.rst b/docs/admin/index.rst
@@ -8,10 +8,13 @@ practices.
 .. rubric:: Table of contents
 
 .. toctree::
-   :maxdepth: 1
-
-   general-upgrade-guidelines
-   rolling-upgrade
-   full-restart-upgrade
-   bootstrap-checks
+    :maxdepth: 1
+
+    bootstrap-checks
+    going-into-production
+    clustering/index
+    troubleshooting/index
+    upgrade/planning
+    upgrade/rolling
+    upgrade/full
 
diff --git a/docs/best-practices/crate-node.rst → docs/admin/troubleshooting/crate-node.rst b/docs/best-practices/crate-node.rst → docs/admin/troubleshooting/crate-node.rst
diff --git a/docs/troubleshooting/docker-jcmd.rst → docs/admin/troubleshooting/docker-jcmd.rst b/docs/troubleshooting/docker-jcmd.rst → docs/admin/troubleshooting/docker-jcmd.rst
diff --git a/docs/troubleshooting/index.rst → docs/admin/troubleshooting/index.rst b/docs/troubleshooting/index.rst → docs/admin/troubleshooting/index.rst
@@ -11,5 +11,7 @@ A collection of guides and tools for troubleshooting CrateDB.
 .. toctree::
    :maxdepth: 1
 
+   crate-node
    docker-jcmd
+   systables
 
diff --git a/docs/best-practices/systables.rst → docs/admin/troubleshooting/systables.rst b/docs/best-practices/systables.rst → docs/admin/troubleshooting/systables.rst
diff --git a/docs/admin/full-restart-upgrade.rst → docs/admin/upgrade/full.rst b/docs/admin/full-restart-upgrade.rst → docs/admin/upgrade/full.rst
diff --git a/docs/admin/general-upgrade-guidelines.rst → docs/admin/upgrade/planning.rst b/docs/admin/general-upgrade-guidelines.rst → docs/admin/upgrade/planning.rst
@@ -22,7 +22,7 @@ Before kicking off an upgrade, there is a set of guidelines to ensure the best o
    This is not an exhaustive list, so you should consider your organization's specific needs and incorporate any additional steps or considerations that are relevant to your environment.
 
 Acknowledge breaking changes
------------------------------
+----------------------------
 
 Review the `release notes`_ and documentation for the target version to understand any potential impact on existing functionality. 
 Ensure to review the intermediate versions' documentation also. For example, when upgrading from 4.8 to 5.3, besides reviewing 5.3 release notes, check for version 5.0, 5.1, and so on.
@@ -45,7 +45,7 @@ For the newly written records, you should consider using a mechanism to queue th
    Before starting the upgrade process, ensure no backup processes are triggered, so disable any scheduled backup.
 
 Define a rollback plan
------------------------
+----------------------
 
 The rollback plan may vary depending on the specific infrastructure and upgrade process in use. It is also essential to adapt this outline to your organization's specific needs and incorporate any additional steps or considerations that are relevant to your environment. A set of steps to serve as an example is listed below:
 

diff --git a/docs/admin/rolling-upgrade.rst → docs/admin/upgrade/rolling.rst b/docs/admin/rolling-upgrade.rst → docs/admin/upgrade/rolling.rst
diff --git a/docs/best-practices/index.rst b/docs/best-practices/index.rst
diff --git a/docs/getting-started/index.rst b/docs/getting-started/index.rst
diff --git a/docs/getting-started/create-user.rst → docs/handbook/create-user.rst b/docs/getting-started/create-user.rst → docs/handbook/create-user.rst
diff --git a/docs/getting-started/first-use.rst → docs/handbook/first-use.rst b/docs/getting-started/first-use.rst → docs/handbook/first-use.rst
diff --git a/docs/handbook/index.rst b/docs/handbook/index.rst
@@ -0,0 +1,18 @@
+########
+Handbook
+########
+
+A collection of CrateDB best practices and tips for common scenarios.
+
+.. rubric:: Table of contents
+
+.. toctree::
+    :maxdepth: 1
+
+    first-use
+    create-user
+    sharding-partitioning
+    performance/index
+    migrate/mysql
+    migrate/mongodb
+
diff --git a/...best-practices/migrating-from-mongodb.rst → docs/handbook/migrate/mongodb.rst b/...best-practices/migrating-from-mongodb.rst → docs/handbook/migrate/mongodb.rst
diff --git a/docs/best-practices/migrating-from-mysql.rst → docs/handbook/migrate/mysql.rst b/docs/best-practices/migrating-from-mysql.rst → docs/handbook/migrate/mysql.rst
diff --git a/docs/performance/index.rst → docs/handbook/performance/index.rst b/docs/performance/index.rst → docs/handbook/performance/index.rst
diff --git a/docs/performance/inserts/bulk.rst → docs/handbook/performance/inserts/bulk.rst b/docs/performance/inserts/bulk.rst → docs/handbook/performance/inserts/bulk.rst
diff --git a/docs/performance/inserts/index.rst → docs/handbook/performance/inserts/index.rst b/docs/performance/inserts/index.rst → docs/handbook/performance/inserts/index.rst
diff --git a/docs/performance/inserts/methods.rst → .../handbook/performance/inserts/methods.rst b/docs/performance/inserts/methods.rst → .../handbook/performance/inserts/methods.rst
diff --git a/docs/performance/inserts/parallel.rst → ...handbook/performance/inserts/parallel.rst b/docs/performance/inserts/parallel.rst → ...handbook/performance/inserts/parallel.rst
diff --git a/docs/performance/inserts/testing.rst → .../handbook/performance/inserts/testing.rst b/docs/performance/inserts/testing.rst → .../handbook/performance/inserts/testing.rst
diff --git a/docs/performance/inserts/tuning.rst → docs/handbook/performance/inserts/tuning.rst b/docs/performance/inserts/tuning.rst → docs/handbook/performance/inserts/tuning.rst
diff --git a/docs/performance/memory.rst → docs/handbook/performance/memory.rst b/docs/performance/memory.rst → docs/handbook/performance/memory.rst
diff --git a/docs/performance/selects.rst → docs/handbook/performance/selects.rst b/docs/performance/selects.rst → docs/handbook/performance/selects.rst
diff --git a/docs/performance/sharding.rst → docs/handbook/performance/sharding.rst b/docs/performance/sharding.rst → docs/handbook/performance/sharding.rst
diff --git a/.../best-practices/sharding-partitioning.rst → docs/handbook/sharding-partitioning.rst b/.../best-practices/sharding-partitioning.rst → docs/handbook/sharding-partitioning.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,4 +1,5 @@
 .. _index:
+.. _getting-started:
 
 ==============
 CrateDB Guides
@@ -23,15 +24,12 @@ massive amounts of machine data in real-time.
    :maxdepth: 3
    :titlesonly:
 
-   getting-started/index
    admin/index
-   clustering/index
-   performance/index
-   going-into-production
-   best-practices/index
+   handbook/index
    reference-architectures/index
-   integrations/index
-   troubleshooting/index
+   t/analysis/index
+   t/timeseries/index
+   t/ml/index
 
 
 .. _Tutorials: https://crate.io/docs/crate/tutorials/en/latest/

diff --git a/docs/integrations/index.rst b/docs/integrations/index.rst
diff --git a/docs/t/analysis/index.rst b/docs/t/analysis/index.rst
@@ -0,0 +1,14 @@
+###############################
+Data Analysis and Visualization
+###############################
+
+This section of the documentation covers integrations of CrateDB with other
+tools, specifically related to data analysis and visualization.
+
+.. toctree::
+    :maxdepth: 1
+
+    r
+    powerbi-desktop
+    powerbi-gateway
+
diff --git a/docs/integrations/powerbi-desktop.rst → docs/t/analysis/powerbi-desktop.rst b/docs/integrations/powerbi-desktop.rst → docs/t/analysis/powerbi-desktop.rst
diff --git a/docs/integrations/powerbi-gateway.rst → docs/t/analysis/powerbi-gateway.rst b/docs/integrations/powerbi-gateway.rst → docs/t/analysis/powerbi-gateway.rst
diff --git a/docs/integrations/r.rst → docs/t/analysis/r.rst b/docs/integrations/r.rst → docs/t/analysis/r.rst
diff --git a/docs/t/ml/index.rst b/docs/t/ml/index.rst
@@ -0,0 +1,12 @@
+#############################
+Machine Learning with CrateDB
+#############################
+
+This section of the documentation covers integrations of CrateDB with machine
+learning frameworks and tools.
+
+.. toctree::
+   :maxdepth: 1
+
+   tensorflow
+
diff --git a/docs/integrations/ml-dist.rst → docs/t/ml/tensorflow.rst b/docs/integrations/ml-dist.rst → docs/t/ml/tensorflow.rst
diff --git a/docs/integrations/azure-functions.rst → docs/t/timeseries/azure-functions.rst b/docs/integrations/azure-functions.rst → docs/t/timeseries/azure-functions.rst
diff --git a/...ting-started/generate-time-series/cli.rst → docs/t/timeseries/generate/cli.rst b/...ting-started/generate-time-series/cli.rst → docs/t/timeseries/generate/cli.rst
diff --git a/...tting-started/generate-time-series/go.rst → docs/t/timeseries/generate/go.rst b/...tting-started/generate-time-series/go.rst → docs/t/timeseries/generate/go.rst
diff --git a/...ng-started/generate-time-series/index.rst → docs/t/timeseries/generate/index.rst b/...ng-started/generate-time-series/index.rst → docs/t/timeseries/generate/index.rst
diff --git a/...ing-started/generate-time-series/node.rst → docs/t/timeseries/generate/node.rst b/...ing-started/generate-time-series/node.rst → docs/t/timeseries/generate/node.rst
diff --git a/...g-started/generate-time-series/python.rst → docs/t/timeseries/generate/python.rst b/...g-started/generate-time-series/python.rst → docs/t/timeseries/generate/python.rst
diff --git a/docs/t/timeseries/index.rst b/docs/t/timeseries/index.rst
@@ -0,0 +1,33 @@
+#############################
+Working with Time Series Data
+#############################
+
+This section of the documentation covers integrations of CrateDB with other
+tools, with respect to time-series use-cases.
+
+
+.. rubric:: Basics
+
+.. toctree::
+    :maxdepth: 1
+
+    generate/index
+    normalize-intervals
+
+
+.. rubric:: Ingestion
+
+.. toctree::
+    :maxdepth: 1
+
+    kafka-connect
+    streamsets
+
+
+.. rubric:: Enrichment
+
+.. toctree::
+    :maxdepth: 1
+
+    azure-functions
+
diff --git a/docs/integrations/kafka-connect.rst → docs/t/timeseries/kafka-connect.rst b/docs/integrations/kafka-connect.rst → docs/t/timeseries/kafka-connect.rst
diff --git a/docs/getting-started/normalize-intervals.rst → docs/t/timeseries/normalize-intervals.rst b/docs/getting-started/normalize-intervals.rst → docs/t/timeseries/normalize-intervals.rst
diff --git a/docs/integrations/streamsets.rst → docs/t/timeseries/streamsets.rst b/docs/integrations/streamsets.rst → docs/t/timeseries/streamsets.rst