From 058825a53738bc4ad0a68c38fff610ff5349a17e Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Wed, 26 Jul 2023 18:40:04 +0200 Subject: [PATCH 1/6] Chore: Switch default branch to `main --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index f3472ca..d1a7aca 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -3,7 +3,7 @@ on: pull_request: ~ push: branches: - - master + - main jobs: documentation: From 0b05d88baca5d2556f948dfcfdecd4b67d64b9c7 Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Wed, 26 Jul 2023 18:54:56 +0200 Subject: [PATCH 2/6] Adjust links to accompany renaming to `services-docs` - GitHub repository name is `services-docs` - Canonical HTTP entry point is `/services/docs` - RTD project name is `crate-services` --- CHANGES.rst | 10 ++++++++++ README.rst | 12 ++++++------ docs/cloud-howtos/index.rst | 2 +- docs/cloud-tutorials/edge/monitoring.rst | 4 ++-- docs/index.rst | 6 +++--- 5 files changed, 22 insertions(+), 12 deletions(-) create mode 100644 CHANGES.rst diff --git a/CHANGES.rst b/CHANGES.rst new file mode 100644 index 0000000..984d7a5 --- /dev/null +++ b/CHANGES.rst @@ -0,0 +1,10 @@ +======= +Changes +======= + + +Unreleased +========== + +- Consolidate ``cloud-reference``, ``cloud-howtos``, and ``cloud-tutorials`` +- Adjust links to accompany renaming to ``services-docs`` diff --git a/README.rst b/README.rst index 7d081e7..fe9bcbf 100644 --- a/README.rst +++ b/README.rst @@ -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/services-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/services-docs/actions/workflows/docs.yml -.. |rtd| image:: https://readthedocs.org/projects/crate-cloud-reference/badge/?version=latest +.. |rtd| image:: https://readthedocs.org/projects/crate-services/badge/?version=latest :alt: Read The Docs status :scale: 100% - :target: https://crate-cloud-reference.readthedocs.io/en/latest/?badge=latest + :target: https://crate-services.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%2Fservices-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/services-docs/blob/main/docs/build.json diff --git a/docs/cloud-howtos/index.rst b/docs/cloud-howtos/index.rst index 6f2fbab..5c58122 100644 --- a/docs/cloud-howtos/index.rst +++ b/docs/cloud-howtos/index.rst @@ -48,4 +48,4 @@ documentation for :ref:`Croud `, the CLI for CrateDB Cloud. private-endpoints -.. _GitHub: https://github.com/crate/cloud-howtos/ +.. _GitHub: https://github.com/crate/services-docs/ diff --git a/docs/cloud-tutorials/edge/monitoring.rst b/docs/cloud-tutorials/edge/monitoring.rst index d1bac09..4310105 100644 --- a/docs/cloud-tutorials/edge/monitoring.rst +++ b/docs/cloud-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/services-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/services-docs/raw/main/docs/_extra/cratedb-edge-logs-dashboard.json .. _Prometheus: https://grafana.com/oss/prometheus/ diff --git a/docs/index.rst b/docs/index.rst index 5667330..1683c81 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -33,6 +33,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-docs -.. _How-To Guides: https://crate.io/docs/cloud/howtos/en/latest/ -.. _Reference: https://crate.io/docs/cloud/reference/en/latest/ +.. _GitHub: https://github.com/crate/services-docs +.. _How-To Guides: https://crate.io/docs/services/en/latest/cloud-howtos/ +.. _Reference: https://crate.io/docs/services/en/latest/cloud-reference/ From 8c0735289797d77ad86f4922aed339fef26721c2 Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Wed, 26 Jul 2023 18:56:51 +0200 Subject: [PATCH 3/6] Adjust intersphinx references to accompany repository consolidation Because the other ones will cease to exist, let's directly link to the corresponding anchor definitions instead. --- CHANGES.rst | 1 + docs/cloud-howtos/index.rst | 8 ++++---- docs/cloud-howtos/snapshot.rst | 2 +- docs/cloud-howtos/visualize-data-with-grafana.rst | 2 +- docs/cloud-reference/billing.rst | 4 ++-- docs/cloud-reference/subscription-plans.rst | 7 +++---- docs/cloud-reference/user-roles.rst | 4 ++-- docs/cloud-tutorials/promotions/free-trial-budget.rst | 2 +- 8 files changed, 15 insertions(+), 15 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 984d7a5..7eae74a 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -8,3 +8,4 @@ Unreleased - Consolidate ``cloud-reference``, ``cloud-howtos``, and ``cloud-tutorials`` - Adjust links to accompany renaming to ``services-docs`` +- Adjust intersphinx references to accompany consolidation into single repository diff --git a/docs/cloud-howtos/index.rst b/docs/cloud-howtos/index.rst index 5c58122..a454dbe 100644 --- a/docs/cloud-howtos/index.rst +++ b/docs/cloud-howtos/index.rst @@ -20,10 +20,10 @@ documentation for :ref:`Croud `, the CLI for CrateDB Cloud. .. NOTE:: This resource assumes you know the basics. If not, check out the - :ref:`tutorials ` section for how to get started. - Additionally, the :ref:`reference ` section contains - a :ref:`glossary ` as well as an - :ref:`overview ` of the CrateDB Cloud Console to + :ref:`tutorials ` section for how to get started. + Additionally, the :ref:`reference ` section contains + a :ref:`glossary ` as well as an + :ref:`overview ` of the CrateDB Cloud Console to give you further information. .. SEEALSO:: diff --git a/docs/cloud-howtos/snapshot.rst b/docs/cloud-howtos/snapshot.rst index 1c25f33..5866cee 100644 --- a/docs/cloud-howtos/snapshot.rst +++ b/docs/cloud-howtos/snapshot.rst @@ -11,7 +11,7 @@ CrateDB handles snapshots can be found in the CrateDB documentation about :ref:`snapshots `. You may also want to read our reference on :ref:`the backup page on the -CrateDB Cloud Console `. +CrateDB Cloud Console `. .. rubric:: Table of contents diff --git a/docs/cloud-howtos/visualize-data-with-grafana.rst b/docs/cloud-howtos/visualize-data-with-grafana.rst index a800708..baafec9 100644 --- a/docs/cloud-howtos/visualize-data-with-grafana.rst +++ b/docs/cloud-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 -`. +`. .. rubric:: Table of contents diff --git a/docs/cloud-reference/billing.rst b/docs/cloud-reference/billing.rst index 484aab4..ff11c2b 100644 --- a/docs/cloud-reference/billing.rst +++ b/docs/cloud-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 `. 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 -`, using our CrateDB Console cluster +`, 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/subscription-plans.rst b/docs/cloud-reference/subscription-plans.rst index f06697b..ddb48b6 100644 --- a/docs/cloud-reference/subscription-plans.rst +++ b/docs/cloud-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 ` that you may have +:ref:`Free Credit ` 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 -`, or :ref:`AWS -` marketplace deployment tutorials. +For details visit :ref:`Azure `, or :ref:`AWS +` marketplace deployment tutorials. .. _subscription-plans-contracts: diff --git a/docs/cloud-reference/user-roles.rst b/docs/cloud-reference/user-roles.rst index 16dcd15..bfc30d9 100644 --- a/docs/cloud-reference/user-roles.rst +++ b/docs/cloud-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 ` or -:ref:`Azure `. +through :ref:`AWS ` or +:ref:`Azure `. 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/cloud-tutorials/promotions/free-trial-budget.rst b/docs/cloud-tutorials/promotions/free-trial-budget.rst index 40e2a6e..607e766 100644 --- a/docs/cloud-tutorials/promotions/free-trial-budget.rst +++ b/docs/cloud-tutorials/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 -`. +`. 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 From 93fad669e97b0fd638af847d046b119082925e81 Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Wed, 26 Jul 2023 18:57:18 +0200 Subject: [PATCH 4/6] Chore: Update .gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 588d735..f9baf9e 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,5 @@ .crate-docs .DS_Store .env +.idea *.lint From 6c68ef909488222b5679a78fdab99e4e5364406b Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Wed, 26 Jul 2023 18:58:22 +0200 Subject: [PATCH 5/6] Slot this project into the documentation tree at `services` --- README.rst | 6 +++--- docs/conf.py | 2 +- docs/index.rst | 7 +++++++ 3 files changed, 11 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index fe9bcbf..1f0285d 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,6 @@ -================== -CrateDB Cloud Docs -================== +============================== +CrateDB Services Documentation +============================== |ci| |rtd| |build| diff --git a/docs/conf.py b/docs/conf.py index 50a7fb3..26f0e77 100644 --- 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.services import * linkcheck_ignore = [ "https://eks1.eu-west-1.aws.cratedb.cloud", diff --git a/docs/index.rst b/docs/index.rst index 1683c81..94c25a7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,3 +1,10 @@ +.. _services-docs-index: + +################ +CrateDB Services +################ + + .. _cloud-docs-index: ============= From 14bf24b268730b991a8fdc1aa66327b35bd84f0f Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Wed, 26 Jul 2023 19:06:23 +0200 Subject: [PATCH 6/6] [TEMP] Use `crate-docs-theme` feature branch to validate building works --- docs/requirements.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index ced14fe..ab5f070 100644 --- 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