Skip to content

Fix dead links and make minor cleanups in documentation #2499

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 25, 2025
Merged

Fix dead links and make minor cleanups in documentation #2499

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d779fa9
Make README.md links point at the docs site
mflendrich Feb 24, 2025
1e6f3a0
Name RELEASE.md consistently with other markdown files
mflendrich Feb 24, 2025
28ec55d
Add a readme in the docs directory
mflendrich Feb 24, 2025
f100d42
Fix broken links & typos in documentation
mflendrich Feb 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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
Expand Down
0 release.md → RELEASE.md
View file
Open in desktop
File renamed without changes.
7 changes: 7 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion docs/source/quickstarts/eks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/source/quickstarts/gke.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
10 changes: 5 additions & 5 deletions docs/source/resources/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ 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
:link: /resources/scylladbmonitorings

ScyllaDBMonitoring defines and manages a ScyllaDB monitoring stack.
+++
[Learn more »](/resources/scylladbmonitorings)
[Learn more »](./scylladbmonitorings.md)
:::

::::
Expand All @@ -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
Expand All @@ -51,15 +51,15 @@ 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
:link: /resources/scyllaoperatorconfigs

ScyllaOperatorConfig configures the {{productName}} deployment and reports the status.
+++
[Learn more »](/resources/scyllaoperatorconfigs)
[Learn more »](./scyllaoperatorconfigs.md)
:::

::::