From 290bacba90708acc53463ccc4bea77d6b6afa8ea Mon Sep 17 00:00:00 2001 From: Yaniv Michael Kaul Date: Thu, 26 Dec 2024 11:58:21 +0200 Subject: [PATCH] README.md: fix quickstart links Fixes: https://github.com/scylladb/scylla-operator/issues/2270 In addition, renamed Scylla to ScyllaDB when needed. Signed-off-by: Yaniv Kaul --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6d7d5bb6b8d..56560e19abc 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,14 @@ [![LICENSE](https://img.shields.io/github/license/scylladb/scylla-operator.svg)](https://github.com/scylladb/scylla-operator/blob/master/LICENSE) -[Scylla Operator](https://github.com/scylladb/scylla-operator) is a Kubernetes Operator for managing and automating tasks related to managing Scylla clusters. +[Scylla Operator](https://github.com/scylladb/scylla-operator) is a Kubernetes Operator for managing and automating tasks related to managing ScyllaDB clusters. -[Scylla](https://www.scylladb.com) is a close-to-the-hardware rewrite of Cassandra in C++. It features a shared nothing architecture that enables true linear scaling and major hardware optimizations that achieve ultra-low latencies and extreme throughput. It is a drop-in replacement for Cassandra and uses the same interfaces. +[ScyllaDB](https://www.scylladb.com) is a close-to-the-hardware rewrite of Cassandra in C++. It features a shared nothing architecture that enables true linear scaling and major hardware optimizations that achieve ultra-low latencies and extreme throughput. It is a drop-in replacement for Cassandra and uses the same interfaces. ![](logo.png) ## Deploying the Operator -For version requirements see the [support matrix](./docs/source/releases.md). +For version requirements see the [support matrix](./docs/source/support/releases.md). ### 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,13 +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: -* [Generic](docs/source/generic.md): Follow this guide for the general way to use the operator. -* [GKE](docs/source/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/eks.md): An advanced guide for deploying Scylla with the **best performance settings** on [Amazon Elastic Kubernetes Service](https://aws.amazon.com/eks/). +* [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. + +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/). * [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/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](./docs/source/support/releases.md). ## Documentation Scylla Operator documentation is available on https://operator.docs.scylladb.com @@ -68,7 +72,7 @@ TODO: Link a dedicated roadmap. ## Support If you find a bug please file an [issue](https://github.com/scylladb/scylla-operator/issues) for us. -We are also available on `#scylla-operator` channel on [Slack](https://scylladb-users-slackin.herokuapp.com/) if you have questions. +We are also available on `#scylla-operator` channel on [Slack](https://scylladb-users.slack.com) if you have questions. ## Contributing We would **love** you to contribute to Scylla Operator, help make it even better and learn together! Have a look at the [Contributing Guide](docs/source/contributing.md) or reach out to us on `#scylla-operator` channel on [Slack](https://scylladb-users-slackin.herokuapp.com/) if you have questions.