Refactor "User Handbooks" section

crate · Oct 26, 2023 · 2c16be0 · 2c16be0
1 parent 02c8776
commit 2c16be0
Show file tree

Hide file tree

Showing 10 changed files with 28 additions and 21 deletions.
diff --git a/docs/getting-started/create-user.rst → .../handbook/getting-started/create-user.rst b/docs/getting-started/create-user.rst → .../handbook/getting-started/create-user.rst
diff --git a/docs/getting-started/first-use.rst → docs/handbook/getting-started/first-use.rst b/docs/getting-started/first-use.rst → docs/handbook/getting-started/first-use.rst
diff --git a/docs/getting-started/index.rst → docs/handbook/getting-started/index.rst b/docs/getting-started/index.rst → docs/handbook/getting-started/index.rst
@@ -1,3 +1,5 @@
+.. _getting-started:
+
 ###############
 Getting Started
 ###############

diff --git a/docs/getting-started/migrate/mongodb.rst → ...dbook/getting-started/migrate/mongodb.rst b/docs/getting-started/migrate/mongodb.rst → ...dbook/getting-started/migrate/mongodb.rst
diff --git a/docs/getting-started/migrate/mysql.rst → ...andbook/getting-started/migrate/mysql.rst b/docs/getting-started/migrate/mysql.rst → ...andbook/getting-started/migrate/mysql.rst
diff --git a/docs/handbook/index.rst b/docs/handbook/index.rst
@@ -1,6 +1,9 @@
-########
-Handbook
-########
+.. _handbooks:
+.. _user-handbooks:
+
+##############
+User Handbooks
+##############
 
 A collection of CrateDB best practices and tips for common scenarios
 around the topics of sharding, partitioning, and performance tuning.
@@ -10,6 +13,7 @@ around the topics of sharding, partitioning, and performance tuning.
 .. toctree::
     :maxdepth: 1
 
+    getting-started/index
     sharding-partitioning
     performance/index
 
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,18 +1,14 @@
 .. _index:
-.. _getting-started:
+.. _guides:
+.. _tutorials:
 
-==============
-CrateDB Guides
-==============
+############################
+CrateDB Guides and Tutorials
+############################
 
 CrateDB is a distributed SQL database that makes it simple to store and analyze
 massive amounts of machine data in real-time.
 
-.. NOTE::
-
-    This resource assumes you know the basics. If not, check out the
-    `Tutorials`_ section for beginner material.
-
 .. SEEALSO::
 
     This is an open source documentation project. We host the source code and
@@ -24,14 +20,13 @@ massive amounts of machine data in real-time.
     :maxdepth: 3
     :titlesonly:
 
-    getting-started/index
-    admin/index
     handbook/index
+    admin/index
+
     reference-architectures/index
     t/analysis/index
     t/timeseries/index
     t/ml/index
 
 
-.. _Tutorials: https://crate.io/docs/crate/tutorials/en/latest/
 .. _GitHub: https://github.com/crate/cratedb-guides
diff --git a/docs/t/analysis/index.rst b/docs/t/analysis/index.rst
@@ -1,3 +1,6 @@
+.. _analysis:
+.. _visualization:
+
 ###############################
 Data Analysis and Visualization
 ###############################

diff --git a/docs/t/ml/index.rst b/docs/t/ml/index.rst
@@ -1,6 +1,9 @@
-#############################
-Machine Learning with CrateDB
-#############################
+.. _ml:
+.. _machine-learning:
+
+################
+Machine Learning
+################
 
 This section of the documentation covers integrations of CrateDB with machine
 learning frameworks and tools.

diff --git a/docs/t/timeseries/index.rst b/docs/t/timeseries/index.rst
@@ -1,6 +1,6 @@
-#############################
-Working with Time Series Data
-#############################
+################
+Time Series Data
+################
 
 This section of the documentation covers integrations of CrateDB with other
 tools, with respect to time-series use-cases.