Skip to content

Commit 8f0169c

Browse files
mykaulmflendrich
authored andcommitted
README.md: fix quickstart links
Fixes: scylladb#2270 In addition, renamed Scylla to ScyllaDB when needed. Signed-off-by: Yaniv Kaul <[email protected]>
1 parent 9e76df9 commit 8f0169c

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

+13-9
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77
[![LICENSE](https://img.shields.io/github/license/scylladb/scylla-operator.svg)](https://github.com/scylladb/scylla-operator/blob/master/LICENSE)
88

99

10-
[Scylla Operator](https://github.com/scylladb/scylla-operator) is a Kubernetes Operator for managing and automating tasks related to managing Scylla clusters.
10+
[Scylla Operator](https://github.com/scylladb/scylla-operator) is a Kubernetes Operator for managing and automating tasks related to managing ScyllaDB clusters.
1111

12-
[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.
12+
[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.
1313

1414
![](logo.png)
1515

1616
## Deploying the Operator
17-
For version requirements see the [support matrix](./docs/source/releases.md).
17+
For version requirements see the [support matrix](./docs/source/support/releases.md).
1818

1919
### GitOps
2020
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
3636
## Quickstarts and Training
3737
To quickly deploy a ScyllaCluster, you can choose one of the following options:
3838

39-
* [Generic](docs/source/generic.md): Follow this guide for the general way to use the operator.
40-
* [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).
41-
* [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/).
39+
* [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.
40+
* [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.
41+
42+
ScyllaDB Installation:
43+
* [Generic](./docs/source/installation/kubernetes/generic.md): Follow this guide for the general way to use the operator.
44+
* [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).
45+
* [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/).
4246
* [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.
4347

4448
## Releases
45-
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).
49+
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).
4650

4751
## Documentation
4852
Scylla Operator documentation is available on https://operator.docs.scylladb.com
@@ -68,7 +72,7 @@ TODO: Link a dedicated roadmap.
6872
## Support
6973
If you find a bug please file an [issue](https://github.com/scylladb/scylla-operator/issues) for us.
7074

71-
We are also available on `#scylla-operator` channel on [Slack](https://scylladb-users-slackin.herokuapp.com/) if you have questions.
75+
We are also available on `#scylla-operator` channel on [Slack](https://scylladb-users.slack.com) if you have questions.
7276

7377
## Contributing
74-
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.
78+
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.slack.com/) if you have questions.

0 commit comments

Comments
 (0)