From 99d3449989eadcf3683989eeaddce67740295fa6 Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Thu, 27 Jul 2023 14:06:24 +0200 Subject: [PATCH] Adjust more intersphinx references and links after renaming directories --- docs/howtos/add-users.rst | 4 ++-- docs/howtos/delete-cluster.rst | 6 +++--- docs/howtos/suspend-cluster.rst | 2 +- docs/index.rst | 10 +++++----- docs/reference/index.rst | 2 +- docs/tutorials/edge/self-hosted-edge.rst | 4 ++-- docs/tutorials/index.rst | 2 +- 7 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/howtos/add-users.rst b/docs/howtos/add-users.rst index b69d0b4..1459145 100644 --- a/docs/howtos/add-users.rst +++ b/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 ` but is +CrateDB Cloud Console :ref:`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 `.) +:ref:`user roles `.) .. image:: ../_assets/img/users-overview.png :alt: Cloud Console users overview diff --git a/docs/howtos/delete-cluster.rst b/docs/howtos/delete-cluster.rst index f763625..76ed209 100644 --- a/docs/howtos/delete-cluster.rst +++ b/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 ` for the +Although the :ref:`general documentation ` 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 `, +from scratch via Microsoft Azure `, 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 -`. +`. 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/howtos/suspend-cluster.rst b/docs/howtos/suspend-cluster.rst index 0b24be2..00bd9af 100644 --- a/docs/howtos/suspend-cluster.rst +++ b/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 -`. +`. .. rubric:: Table of contents diff --git a/docs/index.rst b/docs/index.rst index 52e43f4..5c70ff7 100644 --- 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/en/latest/cloud-howtos/ -.. _Reference: https://crate.io/docs/cloud/en/latest/cloud-reference/ +.. _How-To Guides: https://crate.io/docs/cloud/en/latest/howtos/ +.. _Reference: https://crate.io/docs/cloud/en/latest/reference/ diff --git a/docs/reference/index.rst b/docs/reference/index.rst index a8e3e9a..e8a0b71 100644 --- a/docs/reference/index.rst +++ b/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/tutorials/edge/self-hosted-edge.rst b/docs/tutorials/edge/self-hosted-edge.rst index cd090e3..580fb02 100644 --- a/docs/tutorials/edge/self-hosted-edge.rst +++ b/docs/tutorials/edge/self-hosted-edge.rst @@ -126,7 +126,7 @@ install. The ```` 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 Console overview `. With this, you should be ready to use CrateDB Edge via Microk8s. @@ -246,7 +246,7 @@ install. The ```` 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 Console overview `. With this, you should be ready to use CrateDB Edge via K3S. diff --git a/docs/tutorials/index.rst b/docs/tutorials/index.rst index 20cd0f8..cd03910 100644 --- a/docs/tutorials/index.rst +++ b/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/