From d779fa9b06be986e4dd4a077a438ddad618ace09 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Flendrich?= Date: Mon, 24 Feb 2025 17:17:13 +0100 Subject: [PATCH 1/4] Make README.md links point at the docs site --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 32f9638d269..bd6a261e8fc 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ ![](logo.png) ## Deploying the Operator -For version requirements see the [support matrix](./docs/source/support/releases.md). +For version requirements see the [support matrix](https://operator.docs.scylladb.com/stable/support/releases.html). ### GitOps Kubernetes manifests are located in the `deploy/` folder. To deploy the operator manually using Kubernetes manifests or to integrate it into your GitOps flow please follow [these instructions](./deploy/README.md). @@ -36,17 +36,17 @@ helm repo add scylla-operator https://storage.googleapis.com/scylla-operator-cha ## Quickstarts and Training To quickly deploy a ScyllaCluster, you can choose one of the following options: -* [GKE](./docs/source/quickstarts/gke.md): This is a quickstart guide to help you set up a basic [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine) cluster quickly with local NVMes and solid performance. -* [EKS](./docs/source/quickstarts/eks.md): This is a quickstart guide to help you set up a basic [Amazon Elastic Kubernetes Service](https://aws.amazon.com/eks/) cluster quickly with local NVMes and solid performance. +* [GKE](https://operator.docs.scylladb.com/stable/quickstarts/gke.html): This is a quickstart guide to help you set up a basic [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine) cluster quickly with local NVMes and solid performance. +* [EKS](https://operator.docs.scylladb.com/stable/quickstarts/eks.html): This is a quickstart guide to help you set up a basic [Amazon Elastic Kubernetes Service](https://aws.amazon.com/eks/) cluster quickly with local NVMes and solid performance. ScyllaDB Installation: -* [Generic](./docs/source/installation/kubernetes/generic.md): Follow this guide for the general way to use the operator. -* [GKE](./docs/source/installation/kubernetes/gke.md): An advanced guide for deploying Scylla with the **best performance settings** on [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine). -* [EKS](./docs/source/installation/kubernetes/eks.md): An advanced guide for deploying Scylla with the **best performance settings** on [Amazon Elastic Kubernetes Service](https://aws.amazon.com/eks/). +* [Generic](https://operator.docs.scylladb.com/stable/installation/kubernetes/generic.html): Follow this guide for the general way to use the operator. +* [GKE](https://operator.docs.scylladb.com/stable/installation/kubernetes/gke.html): An advanced guide for deploying Scylla with the **best performance settings** on [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine). +* [EKS](https://operator.docs.scylladb.com/stable/installation/kubernetes/eks.html): An advanced guide for deploying Scylla with the **best performance settings** on [Amazon Elastic Kubernetes Service](https://aws.amazon.com/eks/). * [Scylla University Lesson](https://university.scylladb.com/courses/scylla-operations/lessons/kubernetes-operator/): Follow this lesson on Scylla University to learn more about the Operator and how to use it. The lesson includes some hands-on examples which you can run yourself. ## Releases -To find out more about our releases, support matrix and how our CI/CD is set up there is a [dedicated docs page](./docs/source/support/releases.md). +To find out more about our releases, support matrix and how our CI/CD is set up there is a [dedicated docs page](https://operator.docs.scylladb.com/stable/support/releases.html). ## Documentation Scylla Operator documentation is available on https://operator.docs.scylladb.com From 1e6f3a029adde25ce773e006e602da79c0078972 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Flendrich?= Date: Mon, 24 Feb 2025 17:17:35 +0100 Subject: [PATCH 2/4] Name RELEASE.md consistently with other markdown files --- release.md => RELEASE.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename release.md => RELEASE.md (100%) diff --git a/release.md b/RELEASE.md similarity index 100% rename from release.md rename to RELEASE.md From 28ec55de903403a1589d3e3c75859e6c7900c683 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Flendrich?= Date: Mon, 24 Feb 2025 17:29:35 +0100 Subject: [PATCH 3/4] Add a readme in the docs directory --- docs/README.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000000..4ab979193ee --- /dev/null +++ b/docs/README.md @@ -0,0 +1,7 @@ +## Scylla Operator Documentation + +Product documentation is available at the **[Documentation Site](https://operator.docs.scylladb.com/)**. + +#### Developing the Documentation Site + +Instructions to preview and build the documentation site are available in the [`README-dev.md`](./README-dev.md`) file. From f100d42d34be50a1987f8576090248b5697e1d3f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Flendrich?= Date: Mon, 24 Feb 2025 18:17:25 +0100 Subject: [PATCH 4/4] Fix broken links & typos in documentation --- docs/source/quickstarts/eks.md | 2 +- docs/source/quickstarts/gke.md | 2 +- docs/source/resources/overview.md | 10 +++++----- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/source/quickstarts/eks.md b/docs/source/quickstarts/eks.md index 03738c994e2..23de892bcc2 100644 --- a/docs/source/quickstarts/eks.md +++ b/docs/source/quickstarts/eks.md @@ -38,7 +38,7 @@ To deploy a ScyllaDB cluster please head to [our dedicated section on the topic] ## Accessing ScyllaDB -We also hve a whole section dedicated to [how you can access teh ScyllaDB cluster you've just created](../resources/scyllaclusters/clients/index.md). +We also hve a whole section dedicated to [how you can access the ScyllaDB cluster you've just created](../resources/scyllaclusters/clients/index.md). ## Deleting the EKS cluster diff --git a/docs/source/quickstarts/gke.md b/docs/source/quickstarts/gke.md index c9f731a2be7..50efc871ee6 100644 --- a/docs/source/quickstarts/gke.md +++ b/docs/source/quickstarts/gke.md @@ -66,7 +66,7 @@ To deploy a ScyllaDB cluster please head to [our dedicated section on the topic] ## Accessing ScyllaDB -We also have a whole section dedicated to [how you can access teh ScyllaDB cluster you've just created](../resources/scyllaclusters/clients/index.md). +We also have a whole section dedicated to [how you can access the ScyllaDB cluster you've just created](../resources/scyllaclusters/clients/index.md). ### Deleting a GKE cluster diff --git a/docs/source/resources/overview.md b/docs/source/resources/overview.md index c6e0709638d..c35bbe8e576 100644 --- a/docs/source/resources/overview.md +++ b/docs/source/resources/overview.md @@ -23,7 +23,7 @@ kubectl explain --api-version='scylla.scylladb.com/v1alpha1' NodeConfig.spec ScyllaCluster defines a ScyllaDB datacenter and manages the racks within. +++ -[Learn more »](/resources/scyllaclusters/basics) +[Learn more »](./scyllaclusters/basics.md) ::: :::{grid-item-card} {material-round}`insights;2em` ScyllaDBMonitorings @@ -31,7 +31,7 @@ ScyllaCluster defines a ScyllaDB datacenter and manages the racks within. ScyllaDBMonitoring defines and manages a ScyllaDB monitoring stack. +++ -[Learn more »](/resources/scylladbmonitorings) +[Learn more »](./scylladbmonitorings.md) ::: :::: @@ -41,7 +41,7 @@ ScyllaDBMonitoring defines and manages a ScyllaDB monitoring stack. Cluster scoped resources declare the state for the whole cluster or control something at the cluster level which isn't multitenant. Therefore, working with these resources requires elevated privileges. -Generally, there can be multiple instances of these resources but for some of them, like for [ScyllaOperatorConfigs](scyllaoperatorconfigs.md), it only makes sense to have one instance. We call them *singletons* and the single instance is named `cluster`. +Generally, there can be multiple instances of these resources but for some of them, like for [ScyllaOperatorConfigs](./scyllaoperatorconfigs.md), it only makes sense to have one instance. We call them *singletons* and the single instance is named `cluster`. ::::{grid} 1 1 2 3 :gutter: 4 @@ -51,7 +51,7 @@ Generally, there can be multiple instances of these resources but for some of th NodeConfig manages setup and tuning for a set of Kubernetes nodes. +++ -[Learn more »](/resources/nodeconfigs) +[Learn more »](./nodeconfigs.md) ::: :::{grid-item-card} {material-regular}`settings;2em` ScyllaOperatorConfigs @@ -59,7 +59,7 @@ NodeConfig manages setup and tuning for a set of Kubernetes nodes. ScyllaOperatorConfig configures the {{productName}} deployment and reports the status. +++ -[Learn more »](/resources/scyllaoperatorconfigs) +[Learn more »](./scyllaoperatorconfigs.md) ::: ::::