From 7305c9471ecd73ae341d3d09e8f5a574f8e84d39 Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Fri, 27 Oct 2023 01:46:18 +0200 Subject: [PATCH 1/2] Refactor "User Handbooks" section --- .../getting-started/create-user.rst | 0 .../getting-started/first-use.rst | 0 docs/{ => handbook}/getting-started/index.rst | 2 ++ .../getting-started/migrate/mongodb.rst | 0 .../getting-started/migrate/mysql.rst | 0 docs/handbook/index.rst | 10 +++++++--- docs/index.rst | 19 +++++++------------ docs/t/analysis/index.rst | 3 +++ docs/t/ml/index.rst | 9 ++++++--- docs/t/timeseries/index.rst | 6 +++--- 10 files changed, 28 insertions(+), 21 deletions(-) rename docs/{ => handbook}/getting-started/create-user.rst (100%) rename docs/{ => handbook}/getting-started/first-use.rst (100%) rename docs/{ => handbook}/getting-started/index.rst (91%) rename docs/{ => handbook}/getting-started/migrate/mongodb.rst (100%) rename docs/{ => handbook}/getting-started/migrate/mysql.rst (100%) diff --git a/docs/getting-started/create-user.rst b/docs/handbook/getting-started/create-user.rst similarity index 100% rename from docs/getting-started/create-user.rst rename to docs/handbook/getting-started/create-user.rst diff --git a/docs/getting-started/first-use.rst b/docs/handbook/getting-started/first-use.rst similarity index 100% rename from docs/getting-started/first-use.rst rename to docs/handbook/getting-started/first-use.rst diff --git a/docs/getting-started/index.rst b/docs/handbook/getting-started/index.rst similarity index 91% rename from docs/getting-started/index.rst rename to docs/handbook/getting-started/index.rst index 85423ed2..a0471e2b 100644 --- a/docs/getting-started/index.rst +++ b/docs/handbook/getting-started/index.rst @@ -1,3 +1,5 @@ +.. _getting-started: + ############### Getting Started ############### diff --git a/docs/getting-started/migrate/mongodb.rst b/docs/handbook/getting-started/migrate/mongodb.rst similarity index 100% rename from docs/getting-started/migrate/mongodb.rst rename to docs/handbook/getting-started/migrate/mongodb.rst diff --git a/docs/getting-started/migrate/mysql.rst b/docs/handbook/getting-started/migrate/mysql.rst similarity index 100% rename from docs/getting-started/migrate/mysql.rst rename to docs/handbook/getting-started/migrate/mysql.rst diff --git a/docs/handbook/index.rst b/docs/handbook/index.rst index 15ba115d..20164a0f 100644 --- 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 index 5c199656..d4a530fe 100644 --- 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 index 9ae078e1..4e2bec4c 100644 --- 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 index 94213198..8bde6ff5 100644 --- 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 index 78ac50a9..98cd692a 100644 --- 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. From ad70687f74519a70534df67e56a214f601e11f70 Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Fri, 27 Oct 2023 01:46:23 +0200 Subject: [PATCH 2/2] Update backlog --- backlog.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/backlog.md b/backlog.md index 4ef835ba..4685460b 100644 --- a/backlog.md +++ b/backlog.md @@ -2,6 +2,9 @@ - Add homepage with better guidance - Add content from `crate-tutorials` at `/install` -- Add ML content from other patches and repositories +- ML: Add original content by PF +- ML: Add content from other patches and repositories - Link to tutorials in community forum - Backport high-quality content from community forum +- Update HTTP links, use Sphinx references instead +- Render Jupyter Notebooks?