diff --git a/backlog.md b/backlog.md new file mode 100644 index 00000000..4ef835ba --- /dev/null +++ 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 b/docs/admin/clustering/index.rst similarity index 100% rename from docs/clustering/index.rst rename to docs/admin/clustering/index.rst diff --git a/docs/clustering/kubernetes.rst b/docs/admin/clustering/kubernetes.rst similarity index 100% rename from docs/clustering/kubernetes.rst rename to docs/admin/clustering/kubernetes.rst diff --git a/docs/clustering/logical-replication-setup.rst b/docs/admin/clustering/logical-replication-setup.rst similarity index 100% rename from docs/clustering/logical-replication-setup.rst rename to docs/admin/clustering/logical-replication-setup.rst diff --git a/docs/clustering/multi-node-setup.rst b/docs/admin/clustering/multi-node-setup.rst similarity index 99% rename from docs/clustering/multi-node-setup.rst rename to docs/admin/clustering/multi-node-setup.rst index 29f191e2..14dc6279 100644 --- a/docs/clustering/multi-node-setup.rst +++ b/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 b/docs/admin/clustering/multi-zone-setup.rst similarity index 100% rename from docs/clustering/multi-zone-setup.rst rename to docs/admin/clustering/multi-zone-setup.rst diff --git a/docs/going-into-production.rst b/docs/admin/going-into-production.rst similarity index 100% rename from docs/going-into-production.rst rename to docs/admin/going-into-production.rst diff --git a/docs/admin/index.rst b/docs/admin/index.rst index 705d003f..a1918c97 100644 --- 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 b/docs/admin/troubleshooting/crate-node.rst similarity index 100% rename from docs/best-practices/crate-node.rst rename to docs/admin/troubleshooting/crate-node.rst diff --git a/docs/troubleshooting/docker-jcmd.rst b/docs/admin/troubleshooting/docker-jcmd.rst similarity index 100% rename from docs/troubleshooting/docker-jcmd.rst rename to docs/admin/troubleshooting/docker-jcmd.rst diff --git a/docs/troubleshooting/index.rst b/docs/admin/troubleshooting/index.rst similarity index 88% rename from docs/troubleshooting/index.rst rename to docs/admin/troubleshooting/index.rst index aa3c6013..90d4c4a0 100644 --- a/docs/troubleshooting/index.rst +++ b/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 b/docs/admin/troubleshooting/systables.rst similarity index 100% rename from docs/best-practices/systables.rst rename to docs/admin/troubleshooting/systables.rst diff --git a/docs/admin/full-restart-upgrade.rst b/docs/admin/upgrade/full.rst similarity index 100% rename from docs/admin/full-restart-upgrade.rst rename to docs/admin/upgrade/full.rst diff --git a/docs/admin/general-upgrade-guidelines.rst b/docs/admin/upgrade/planning.rst similarity index 98% rename from docs/admin/general-upgrade-guidelines.rst rename to docs/admin/upgrade/planning.rst index 9b70f238..7d860040 100644 --- a/docs/admin/general-upgrade-guidelines.rst +++ b/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 b/docs/admin/upgrade/rolling.rst similarity index 100% rename from docs/admin/rolling-upgrade.rst rename to docs/admin/upgrade/rolling.rst diff --git a/docs/best-practices/index.rst b/docs/best-practices/index.rst deleted file mode 100644 index 83ee2618..00000000 --- a/docs/best-practices/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -============== -Best practices -============== - -A collection of CrateDB best practices and tips for common scenarios. - -.. rubric:: Table of contents - -.. toctree:: - :maxdepth: 1 - - migrating-from-mysql - migrating-from-mongodb - systables - crate-node - sharding-partitioning diff --git a/docs/getting-started/index.rst b/docs/getting-started/index.rst deleted file mode 100644 index 027dfac6..00000000 --- a/docs/getting-started/index.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. _getting-started: - -=============== -Getting started -=============== - -CrateDB is a distributed SQL database that makes it simple to store and analyze -massive amounts of machine data in real-time. - -.. rubric:: Table of contents - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - first-use - create-user - generate-time-series/index - normalize-intervals diff --git a/docs/getting-started/create-user.rst b/docs/handbook/create-user.rst similarity index 100% rename from docs/getting-started/create-user.rst rename to docs/handbook/create-user.rst diff --git a/docs/getting-started/first-use.rst b/docs/handbook/first-use.rst similarity index 100% rename from docs/getting-started/first-use.rst rename to docs/handbook/first-use.rst diff --git a/docs/handbook/index.rst b/docs/handbook/index.rst new file mode 100644 index 00000000..8de1a0e2 --- /dev/null +++ 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/docs/best-practices/migrating-from-mongodb.rst b/docs/handbook/migrate/mongodb.rst similarity index 100% rename from docs/best-practices/migrating-from-mongodb.rst rename to docs/handbook/migrate/mongodb.rst diff --git a/docs/best-practices/migrating-from-mysql.rst b/docs/handbook/migrate/mysql.rst similarity index 100% rename from docs/best-practices/migrating-from-mysql.rst rename to docs/handbook/migrate/mysql.rst diff --git a/docs/performance/index.rst b/docs/handbook/performance/index.rst similarity index 100% rename from docs/performance/index.rst rename to docs/handbook/performance/index.rst diff --git a/docs/performance/inserts/bulk.rst b/docs/handbook/performance/inserts/bulk.rst similarity index 100% rename from docs/performance/inserts/bulk.rst rename to docs/handbook/performance/inserts/bulk.rst diff --git a/docs/performance/inserts/index.rst b/docs/handbook/performance/inserts/index.rst similarity index 100% rename from docs/performance/inserts/index.rst rename to docs/handbook/performance/inserts/index.rst diff --git a/docs/performance/inserts/methods.rst b/docs/handbook/performance/inserts/methods.rst similarity index 100% rename from docs/performance/inserts/methods.rst rename to docs/handbook/performance/inserts/methods.rst diff --git a/docs/performance/inserts/parallel.rst b/docs/handbook/performance/inserts/parallel.rst similarity index 100% rename from docs/performance/inserts/parallel.rst rename to docs/handbook/performance/inserts/parallel.rst diff --git a/docs/performance/inserts/testing.rst b/docs/handbook/performance/inserts/testing.rst similarity index 100% rename from docs/performance/inserts/testing.rst rename to docs/handbook/performance/inserts/testing.rst diff --git a/docs/performance/inserts/tuning.rst b/docs/handbook/performance/inserts/tuning.rst similarity index 100% rename from docs/performance/inserts/tuning.rst rename to docs/handbook/performance/inserts/tuning.rst diff --git a/docs/performance/memory.rst b/docs/handbook/performance/memory.rst similarity index 100% rename from docs/performance/memory.rst rename to docs/handbook/performance/memory.rst diff --git a/docs/performance/selects.rst b/docs/handbook/performance/selects.rst similarity index 100% rename from docs/performance/selects.rst rename to docs/handbook/performance/selects.rst diff --git a/docs/performance/sharding.rst b/docs/handbook/performance/sharding.rst similarity index 100% rename from docs/performance/sharding.rst rename to docs/handbook/performance/sharding.rst diff --git a/docs/best-practices/sharding-partitioning.rst b/docs/handbook/sharding-partitioning.rst similarity index 100% rename from docs/best-practices/sharding-partitioning.rst rename to docs/handbook/sharding-partitioning.rst diff --git a/docs/index.rst b/docs/index.rst index dbfb7cca..06a877b9 100644 --- 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 deleted file mode 100644 index 85835fb0..00000000 --- a/docs/integrations/index.rst +++ /dev/null @@ -1,31 +0,0 @@ -============ -Integrations -============ - -This section of the documentation covers integrations of CrateDB with other -tools. - -.. rubric:: Ingestion - -.. toctree:: - :maxdepth: 1 - - kafka-connect - streamsets - -.. rubric:: Enrichment - -.. toctree:: - :maxdepth: 1 - - azure-functions - -.. rubric:: Data Analysis, Visualization, and Machine Learning - -.. toctree:: - :maxdepth: 1 - - r - powerbi-desktop - powerbi-gateway - ml-dist diff --git a/docs/t/analysis/index.rst b/docs/t/analysis/index.rst new file mode 100644 index 00000000..9ae078e1 --- /dev/null +++ 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 b/docs/t/analysis/powerbi-desktop.rst similarity index 100% rename from docs/integrations/powerbi-desktop.rst rename to docs/t/analysis/powerbi-desktop.rst diff --git a/docs/integrations/powerbi-gateway.rst b/docs/t/analysis/powerbi-gateway.rst similarity index 100% rename from docs/integrations/powerbi-gateway.rst rename to docs/t/analysis/powerbi-gateway.rst diff --git a/docs/integrations/r.rst b/docs/t/analysis/r.rst similarity index 100% rename from docs/integrations/r.rst rename to docs/t/analysis/r.rst diff --git a/docs/t/ml/index.rst b/docs/t/ml/index.rst new file mode 100644 index 00000000..94213198 --- /dev/null +++ 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 b/docs/t/ml/tensorflow.rst similarity index 100% rename from docs/integrations/ml-dist.rst rename to docs/t/ml/tensorflow.rst diff --git a/docs/integrations/azure-functions.rst b/docs/t/timeseries/azure-functions.rst similarity index 100% rename from docs/integrations/azure-functions.rst rename to docs/t/timeseries/azure-functions.rst diff --git a/docs/getting-started/generate-time-series/cli.rst b/docs/t/timeseries/generate/cli.rst similarity index 100% rename from docs/getting-started/generate-time-series/cli.rst rename to docs/t/timeseries/generate/cli.rst diff --git a/docs/getting-started/generate-time-series/go.rst b/docs/t/timeseries/generate/go.rst similarity index 100% rename from docs/getting-started/generate-time-series/go.rst rename to docs/t/timeseries/generate/go.rst diff --git a/docs/getting-started/generate-time-series/index.rst b/docs/t/timeseries/generate/index.rst similarity index 100% rename from docs/getting-started/generate-time-series/index.rst rename to docs/t/timeseries/generate/index.rst diff --git a/docs/getting-started/generate-time-series/node.rst b/docs/t/timeseries/generate/node.rst similarity index 100% rename from docs/getting-started/generate-time-series/node.rst rename to docs/t/timeseries/generate/node.rst diff --git a/docs/getting-started/generate-time-series/python.rst b/docs/t/timeseries/generate/python.rst similarity index 100% rename from docs/getting-started/generate-time-series/python.rst rename to docs/t/timeseries/generate/python.rst diff --git a/docs/t/timeseries/index.rst b/docs/t/timeseries/index.rst new file mode 100644 index 00000000..78ac50a9 --- /dev/null +++ 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 b/docs/t/timeseries/kafka-connect.rst similarity index 100% rename from docs/integrations/kafka-connect.rst rename to docs/t/timeseries/kafka-connect.rst diff --git a/docs/getting-started/normalize-intervals.rst b/docs/t/timeseries/normalize-intervals.rst similarity index 100% rename from docs/getting-started/normalize-intervals.rst rename to docs/t/timeseries/normalize-intervals.rst diff --git a/docs/integrations/streamsets.rst b/docs/t/timeseries/streamsets.rst similarity index 100% rename from docs/integrations/streamsets.rst rename to docs/t/timeseries/streamsets.rst