crate · amotl · Jul 31, 2023 · Jul 26, 2023 · Jul 26, 2023 · Jul 26, 2023
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -0,0 +1,12 @@
+=======
+Changes
+=======
+
+
+Unreleased
+==========
+
+- Consolidate ``cloud-reference``, ``cloud-howtos``, and ``cloud-tutorials``
+- Adjust links to accompany renaming to ``cloud-docs``
+- Adjust intersphinx references to accompany consolidation into single repository
+- Rename top-level directories to `howtos`, `reference`, and `tutorials`
diff --git a/README.rst b/README.rst
@@ -1,6 +1,6 @@
-==================
-CrateDB Cloud Docs
-==================
+===========================
+CrateDB Cloud Documentation
+===========================
 
 |ci| |rtd| |build|
 
@@ -34,16 +34,16 @@ Looking for more help?
 .. _support channels: https://crate.io/support/
 
 
-.. |ci| image:: https://github.com/crate/cloud-reference/actions/workflows/docs.yml/badge.svg
+.. |ci| image:: https://github.com/crate/cloud-docs/actions/workflows/docs.yml/badge.svg
     :alt: CI status
     :scale: 100%
-    :target: https://github.com/crate/cloud-reference/actions/workflows/docs.yml
+    :target: https://github.com/crate/cloud-docs/actions/workflows/docs.yml
 
-.. |rtd| image:: https://readthedocs.org/projects/crate-cloud-reference/badge/?version=latest
+.. |rtd| image:: https://readthedocs.org/projects/crate-cloud/badge/?version=latest
     :alt: Read The Docs status
     :scale: 100%
-    :target: https://crate-cloud-reference.readthedocs.io/en/latest/?badge=latest
+    :target: https://crate-cloud.readthedocs.io/en/latest/?badge=latest
 
-.. |build| image:: https://img.shields.io/endpoint.svg?color=blue&url=https%3A%2F%2Fraw.githubusercontent.com%2Fcrate%2Fcloud-reference%2Fmaster%2Fdocs%2Fbuild.json
+.. |build| image:: https://img.shields.io/endpoint.svg?color=blue&url=https%3A%2F%2Fraw.githubusercontent.com%2Fcrate%2Fcloud-docs%2Fmain%2Fdocs%2Fbuild.json
     :alt: Build version
-    :target: https://github.com/crate/cloud-reference/blob/master/docs/build.json
+    :target: https://github.com/crate/cloud-docs/blob/main/docs/build.json
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,4 +1,4 @@
-from crate.theme.rtd.conf.cloud_reference import *
+from crate.theme.rtd.conf.cloud import *
 
 linkcheck_ignore = [
     "https://eks1.eu-west-1.aws.cratedb.cloud",

diff --git a/docs/cloud-howtos/add-users.rst → docs/howtos/add-users.rst b/docs/cloud-howtos/add-users.rst → docs/howtos/add-users.rst
@@ -6,7 +6,7 @@ Add users
 
 This is a quick guide on how to add users to organizations and
 how to manage their privileges. This information can also be found in the
-CrateDB Cloud Console :ref:`Overview <cloud-reference:overview>` but is
+CrateDB Cloud Console :ref:`Overview <overview>` but is
 presented here separately for ease of use.
 
 .. rubric:: Table of contents
@@ -31,7 +31,7 @@ New users can be added to an organization by going to the Users tab in the
 left-hand menu. To add and manage users of the organization, you must be the
 organization admin. (For more information on user roles and associated
 privileges, see our documentation on 
-:ref:`user roles <cloud-reference:user-roles>`.)
+:ref:`user roles <user-roles>`.)
 
 .. image:: ../_assets/img/users-overview.png
    :alt: Cloud Console users overview

diff --git a/docs/cloud-howtos/connect-to-cluster/cli.rst → docs/howtos/connect-to-cluster/cli.rst b/docs/cloud-howtos/connect-to-cluster/cli.rst → docs/howtos/connect-to-cluster/cli.rst
diff --git a/...cloud-howtos/connect-to-cluster/index.rst → docs/howtos/connect-to-cluster/index.rst b/...cloud-howtos/connect-to-cluster/index.rst → docs/howtos/connect-to-cluster/index.rst
diff --git a/.../cloud-howtos/connect-to-cluster/java.rst → docs/howtos/connect-to-cluster/java.rst b/.../cloud-howtos/connect-to-cluster/java.rst → docs/howtos/connect-to-cluster/java.rst
diff --git a/...-howtos/connect-to-cluster/javascript.rst → .../howtos/connect-to-cluster/javascript.rst b/...-howtos/connect-to-cluster/javascript.rst → .../howtos/connect-to-cluster/javascript.rst
diff --git a/docs/cloud-howtos/connect-to-cluster/php.rst → docs/howtos/connect-to-cluster/php.rst b/docs/cloud-howtos/connect-to-cluster/php.rst → docs/howtos/connect-to-cluster/php.rst
diff --git a/...loud-howtos/connect-to-cluster/python.rst → docs/howtos/connect-to-cluster/python.rst b/...loud-howtos/connect-to-cluster/python.rst → docs/howtos/connect-to-cluster/python.rst
diff --git a/.../cloud-howtos/connect-to-cluster/ruby.rst → docs/howtos/connect-to-cluster/ruby.rst b/.../cloud-howtos/connect-to-cluster/ruby.rst → docs/howtos/connect-to-cluster/ruby.rst
diff --git a/docs/cloud-howtos/create-org.rst → docs/howtos/create-org.rst b/docs/cloud-howtos/create-org.rst → docs/howtos/create-org.rst
diff --git a/docs/cloud-howtos/delete-cluster.rst → docs/howtos/delete-cluster.rst b/docs/cloud-howtos/delete-cluster.rst → docs/howtos/delete-cluster.rst
@@ -10,7 +10,7 @@ Microsoft Azure, the other is for a cluster created through AWS. For Azure,
 there are in turn two methods: via the CrateDB Cloud Console and through the
 Azure Portal. Each are outlined in the Azure section.
 
-Although the :ref:`general documentation <cloud-reference:overview>` for the
+Although the :ref:`general documentation <overview>` for the
 CrateDB Cloud Console explains how you can delete a cluster specifically
 within the Console, this tutorial provides a step-by-step guide for *all*
 methods of deleting a CrateDB Cloud cluster. This is to make the process more
@@ -32,7 +32,7 @@ Microsoft Azure
 ===============
 
 If you have followed the steps of our :ref:`tutorial on how to set up a cluster
-from scratch via Microsoft Azure <cloud-tutorials:signup-azure-to-cluster>`,
+from scratch via Microsoft Azure <signup-azure-to-cluster>`,
 you should have one running. If you created your CrateDB Cloud cluster
 via the Microsoft Azure offering, you have two different ways to delete a
 cluster once it has been created. The first is through the CrateDB Cloud
@@ -49,7 +49,7 @@ The easiest and preferred way to delete a cluster is via the CrateDB Cloud
 Console. Make sure you are logged in to the Console with a user that has
 admin access in the organization where your cluster is deployed. For more on
 what that means, please see our documentation on :ref:`user roles
-<cloud-reference:user-roles>`.
+<user-roles>`.
 
 First, you need to select the cluster in question. To do this, we need to
 access the Clusters page in the left-hand sidebar. There you should see a list

diff --git a/docs/cloud-howtos/index.rst → docs/howtos/index.rst b/docs/cloud-howtos/index.rst → docs/howtos/index.rst
@@ -20,10 +20,10 @@ documentation for :ref:`Croud <cloud-cli:index>`, the CLI for CrateDB Cloud.
 .. NOTE::
 
     This resource assumes you know the basics. If not, check out the
-    :ref:`tutorials <cloud-tutorials:index>` section for how to get started.
-    Additionally, the :ref:`reference <cloud-reference:index>` section contains
-    a :ref:`glossary <cloud-reference:glossary>` as well as an
-    :ref:`overview <cloud-reference:overview>` of the CrateDB Cloud Console to
+    :ref:`tutorials <cloud-tutorials-index>` section for how to get started.
+    Additionally, the :ref:`reference <cloud-reference-index>` section contains
+    a :ref:`glossary <glossary>` as well as an
+    :ref:`overview <overview>` of the CrateDB Cloud Console to
     give you further information.
 
 .. SEEALSO::
@@ -48,4 +48,4 @@ documentation for :ref:`Croud <cloud-cli:index>`, the CLI for CrateDB Cloud.
     private-endpoints
 
 
-.. _GitHub: https://github.com/crate/cloud-howtos/
+.. _GitHub: https://github.com/crate/cloud-docs/
diff --git a/docs/cloud-howtos/logical-replication.rst → docs/howtos/logical-replication.rst b/docs/cloud-howtos/logical-replication.rst → docs/howtos/logical-replication.rst
diff --git a/docs/cloud-howtos/private-endpoints.rst → docs/howtos/private-endpoints.rst b/docs/cloud-howtos/private-endpoints.rst → docs/howtos/private-endpoints.rst
diff --git a/docs/cloud-howtos/reconfigure-cluster.rst → docs/howtos/reconfigure-cluster.rst b/docs/cloud-howtos/reconfigure-cluster.rst → docs/howtos/reconfigure-cluster.rst
diff --git a/docs/cloud-howtos/snapshot.rst → docs/howtos/snapshot.rst b/docs/cloud-howtos/snapshot.rst → docs/howtos/snapshot.rst
@@ -11,7 +11,7 @@ CrateDB handles snapshots can be found in the CrateDB documentation about
 :ref:`snapshots <crate-reference:snapshot-restore>`.
 
 You may also want to read our reference on :ref:`the backup page on the 
-CrateDB Cloud Console <cloud-reference:overview-cluster-backups>`.
+CrateDB Cloud Console <overview-cluster-backups>`.
 
 .. rubric:: Table of contents
 

diff --git a/docs/cloud-howtos/suspend-cluster.rst → docs/howtos/suspend-cluster.rst b/docs/cloud-howtos/suspend-cluster.rst → docs/howtos/suspend-cluster.rst
@@ -8,7 +8,7 @@ This guide will provide a quick overview of how to suspend your cluster using
 the CrateDB Cloud Console. For the purposes of this guide, it is assumed that
 you have a cluster up and running and can access the Console. If not, please
 refer to the :ref:`tutorial on how to deploy a cluster for the first time
-<cloud-tutorials:cluster-deployment>`.
+<cluster-deployment>`.
 
 .. rubric:: Table of contents
 

diff --git a/...ud-howtos/visualize-data-with-grafana.rst → docs/howtos/visualize-data-with-grafana.rst b/...ud-howtos/visualize-data-with-grafana.rst → docs/howtos/visualize-data-with-grafana.rst
@@ -12,7 +12,7 @@ data in real-time.
 For the purposes of this guide, it is assumed that you
 have a cluster up and running and can access the Console. If not, please refer
 to the :ref:`tutorial on how to deploy a cluster for the first time
-<cloud-tutorials:cluster-deployment>`.
+<cluster-deployment>`.
 
 .. rubric:: Table of contents
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -26,13 +26,13 @@ in the tutorials below.
 .. toctree::
     :maxdepth: 4
 
-    cloud-reference/index
-    cloud-tutorials/index
-    cloud-howtos/index
+    reference/index
+    tutorials/index
+    howtos/index
 
 .. _CrateDB Cloud: https://crate.io/products/cratedb-cloud/
 .. _CrateDB: https://crate.io/products/cratedb/
 .. _Croud CLI: https://crate.io/docs/cloud/cli/en/latest/
 .. _GitHub: https://github.com/crate/cloud-docs
-.. _How-To Guides: https://crate.io/docs/cloud/howtos/en/latest/
-.. _Reference: https://crate.io/docs/cloud/reference/en/latest/
+.. _How-To Guides: https://crate.io/docs/cloud/en/latest/howtos/
+.. _Reference: https://crate.io/docs/cloud/en/latest/reference/
diff --git a/docs/cloud-reference/api.rst → docs/reference/api.rst b/docs/cloud-reference/api.rst → docs/reference/api.rst
diff --git a/docs/cloud-reference/billing.rst → docs/reference/billing.rst b/docs/cloud-reference/billing.rst → docs/reference/billing.rst
@@ -77,7 +77,7 @@ Invoicing
 Invoicing is handled variously depending on which deployment method you use.
 If you deploy your cluster directly via the CrateDB Cloud Console, you will be
 invoiced at the email address you provided on :ref:`signing up with CrateDB
-Cloud <cloud-tutorials:sign-up>`.
+Cloud <sign-up>`.
 
 If you use one of the marketplace offers, the invoicing is handled by the
 marketplace provider in question and will be part of your general invoicing for
@@ -114,7 +114,7 @@ Payment processing
 ==================
 
 For clusters deployed in the :ref:`regular way
-<cloud-tutorials:cluster-deployment-stripe>`, using our CrateDB Console cluster
+<cluster-deployment-stripe>`, using our CrateDB Console cluster
 deployment route, payment processing is handled by `Stripe`_. For clusters
 deployed through the `Microsoft Azure Marketplace`_ and the `AWS Marketplace`_,
 payment is handled by Stripe on behalf of the respective marketplaces.

diff --git a/docs/cloud-reference/glossary.rst → docs/reference/glossary.rst b/docs/cloud-reference/glossary.rst → docs/reference/glossary.rst
diff --git a/docs/cloud-reference/index.rst → docs/reference/index.rst b/docs/cloud-reference/index.rst → docs/reference/index.rst
@@ -31,5 +31,5 @@ NoSQL with the power and simplicity of standard SQL.
 
 .. _CrateDB Cloud: https://crate.io/products/cratedb-cloud/
 .. _CrateDB: https://crate.io/products/cratedb/
-.. _GitHub: https://github.com/crate/cloud-reference/
+.. _GitHub: https://github.com/crate/cloud-docs/
 .. _Tutorials: https://crate.io/docs/cloud/tutorials/en/latest/
diff --git a/docs/cloud-reference/overview.rst → docs/reference/overview.rst b/docs/cloud-reference/overview.rst → docs/reference/overview.rst
diff --git a/docs/cloud-reference/subscription-plans.rst → docs/reference/subscription-plans.rst b/docs/cloud-reference/subscription-plans.rst → docs/reference/subscription-plans.rst
@@ -65,7 +65,7 @@ This plan is aimed at new users who want to test and evaluate CrateDB Cloud
 and is perpetually free to use. Every user can deploy one free tier cluster 
 in their organization without adding a payment method. This plan
 also doesn't consume any 
-:ref:`Free Credit <cloud-tutorials:free-trial-budget>` that you may have
+:ref:`Free Credit <free-trial-budget>` that you may have
 available. They are limited to one node with 2 CPUs, 2 GiB of memory, and 4
 GiB of storage.
 
@@ -122,9 +122,8 @@ scaling up/down:
 - Usage is billed based on consumption
 - Billing is done in $0.001 increments for the compute + storage usage
 
-For details visit :ref:`Azure
-<cloud-tutorials:signup-azure-to-cluster>`, or :ref:`AWS
-<cloud-tutorials:signup-aws-to-cluster>` marketplace deployment tutorials.
+For details visit :ref:`Azure <signup-azure-to-cluster>`, or :ref:`AWS
+<signup-aws-to-cluster>` marketplace deployment tutorials.
 
 .. _subscription-plans-contracts:
 

diff --git a/docs/cloud-reference/user-roles.rst → docs/reference/user-roles.rst b/docs/cloud-reference/user-roles.rst → docs/reference/user-roles.rst
@@ -95,8 +95,8 @@ Regular database user
 
 Next to the ``crate`` user there is the regular database user, created as part
 of the CrateDB Cloud cluster deployment wizard when deploying a cluster 
-through :ref:`AWS <cloud-tutorials:signup-aws-to-cluster>` or
-:ref:`Azure <cloud-tutorials:signup-azure-to-cluster>`.
+through :ref:`AWS <signup-aws-to-cluster>` or
+:ref:`Azure <signup-azure-to-cluster>`.
 
 Because the regular database user has `AL privileges`_, there are certain
 operations that they cannot perform. As of CrateDB 4.2.1, the list of such

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1 +1,2 @@
-crate-docs-theme
+git+https://github.com/crate/crate-docs-theme@amo/adjust-leftnav
+# crate-docs-theme
diff --git a/...ud-tutorials/cluster-deployment/croud.rst → docs/tutorials/cluster-deployment/croud.rst b/...ud-tutorials/cluster-deployment/croud.rst → docs/tutorials/cluster-deployment/croud.rst
diff --git a/...e/deploy-to-cluster-aws/subscribe-aws.rst → ...e/deploy-to-cluster-aws/subscribe-aws.rst b/...e/deploy-to-cluster-aws/subscribe-aws.rst → ...e/deploy-to-cluster-aws/subscribe-aws.rst
diff --git a/...ploy-to-cluster-azure/subscribe-azure.rst → ...ploy-to-cluster-azure/subscribe-azure.rst b/...ploy-to-cluster-azure/subscribe-azure.rst → ...ploy-to-cluster-azure/subscribe-azure.rst
diff --git a/...t/deploy-to-cluster-marketplace/index.rst → ...t/deploy-to-cluster-marketplace/index.rst b/...t/deploy-to-cluster-marketplace/index.rst → ...t/deploy-to-cluster-marketplace/index.rst
diff --git a/...ud-tutorials/cluster-deployment/index.rst → docs/tutorials/cluster-deployment/index.rst b/...ud-tutorials/cluster-deployment/index.rst → docs/tutorials/cluster-deployment/index.rst
diff --git a/...d-tutorials/cluster-deployment/stripe.rst → docs/tutorials/cluster-deployment/stripe.rst b/...d-tutorials/cluster-deployment/stripe.rst → docs/tutorials/cluster-deployment/stripe.rst
diff --git a/docs/cloud-tutorials/edge/custom-backup.rst → docs/tutorials/edge/custom-backup.rst b/docs/cloud-tutorials/edge/custom-backup.rst → docs/tutorials/edge/custom-backup.rst
diff --git a/docs/cloud-tutorials/edge/index.rst → docs/tutorials/edge/index.rst b/docs/cloud-tutorials/edge/index.rst → docs/tutorials/edge/index.rst
diff --git a/docs/cloud-tutorials/edge/introduction.rst → docs/tutorials/edge/introduction.rst b/docs/cloud-tutorials/edge/introduction.rst → docs/tutorials/edge/introduction.rst
diff --git a/...oud-tutorials/edge/managed-kubernetes.rst → docs/tutorials/edge/managed-kubernetes.rst b/...oud-tutorials/edge/managed-kubernetes.rst → docs/tutorials/edge/managed-kubernetes.rst
diff --git a/docs/cloud-tutorials/edge/monitoring.rst → docs/tutorials/edge/monitoring.rst b/docs/cloud-tutorials/edge/monitoring.rst → docs/tutorials/edge/monitoring.rst
@@ -241,9 +241,9 @@ If this looks interesting to you, go to `Cloud Console`_ and give it a try!
 
 .. _and Prometheus: https://grafana.com/docs/grafana/latest/datasources/prometheus/
 .. _Cloud Console: https://console.cratedb.cloud/?utm_campaign=2022-Q3-WS-Developer-Motion&utm_source=docs
-.. _Cluster performance dashboard: https://raw.githubusercontent.com/crate/cloud-tutorials/master/docs/_extra/cratedb-edge-cluster-dashboard.json
+.. _Cluster performance dashboard: https://github.com/crate/cloud-docs/raw/main/docs/_extra/cratedb-edge-cluster-dashboard.json
 .. _for Loki: https://grafana.com/docs/loki/latest/
 .. _Grafana: https://grafana.com/
 .. _Loki: https://grafana.com/oss/loki/
-.. _Logs monitoring dashboard: https://raw.githubusercontent.com/crate/cloud-tutorials/master/docs/_extra/cratedb-edge-logs-dashboard.json
+.. _Logs monitoring dashboard: https://github.com/crate/cloud-docs/raw/main/docs/_extra/cratedb-edge-logs-dashboard.json
 .. _Prometheus: https://grafana.com/oss/prometheus/
diff --git a/...cloud-tutorials/edge/self-hosted-edge.rst → docs/tutorials/edge/self-hosted-edge.rst b/...cloud-tutorials/edge/self-hosted-edge.rst → docs/tutorials/edge/self-hosted-edge.rst
@@ -126,7 +126,7 @@ install.
 The ``<token>`` in question is the token you receive from the CrateDB Console
 Edge region field in the Regions tab of the Organization Overview. For more
 information on this section of the CrateDB Console, refer to our :ref:`CrateDB
-Cloud Console overview <cloud-reference:overview-org-regions>`.
+Cloud Console overview <overview-org-regions>`.
 
 With this, you should be ready to use CrateDB Edge via Microk8s.
 
@@ -246,7 +246,7 @@ install.
 The ``<token>`` in question is the token you receive from the CrateDB Console
 Edge region field in the Regions tab of the Organization Overview. For more
 information on this section of the CrateDB Console, refer to our :ref:`CrateDB
-Cloud Console overview <cloud-reference:overview-org-regions>`.
+Cloud Console overview <overview-org-regions>`.
 
 With this, you should be ready to use CrateDB Edge via K3S.
 

diff --git a/docs/cloud-tutorials/index.rst → docs/tutorials/index.rst b/docs/cloud-tutorials/index.rst → docs/tutorials/index.rst
@@ -42,6 +42,6 @@ in the tutorials below.
 .. _CrateDB Cloud: https://crate.io/products/cratedb-cloud/
 .. _CrateDB: https://crate.io/products/cratedb/
 .. _Croud CLI: https://crate.io/docs/cloud/cli/en/latest/
-.. _GitHub: https://github.com/crate/cloud-tutorials
+.. _GitHub: https://github.com/crate/cloud-docs
 .. _How-To Guides: https://crate.io/docs/cloud/howtos/en/latest/
 .. _Reference: https://crate.io/docs/cloud/reference/en/latest/
diff --git a/docs/cloud-tutorials/integrations/index.rst → docs/tutorials/integrations/index.rst b/docs/cloud-tutorials/integrations/index.rst → docs/tutorials/integrations/index.rst
diff --git a/...cloud-tutorials/integrations/metabase.rst → docs/tutorials/integrations/metabase.rst b/...cloud-tutorials/integrations/metabase.rst → docs/tutorials/integrations/metabase.rst
diff --git a/...utorials/promotions/free-trial-budget.rst → ...utorials/promotions/free-trial-budget.rst b/...utorials/promotions/free-trial-budget.rst → ...utorials/promotions/free-trial-budget.rst
@@ -28,7 +28,7 @@ Create an organization
 
 To get the credit, simply create an organization. For the detailed
 instructions, see  :ref:`Create a new organization how-to
-<cloud-howtos:create-org>`.
+<create-org>`.
 
 Enter the desired name for the organization in the field and click *Create
 organization*. Once this is done, you will be returned to the Clusters

diff --git a/docs/cloud-tutorials/sign-up.rst → docs/tutorials/sign-up.rst b/docs/cloud-tutorials/sign-up.rst → docs/tutorials/sign-up.rst