Skip to content

Commit d3951ae

Browse files
Merge pull request #2499 from mflendrich/docs-links-revamp
Fix dead links and make minor cleanups in documentation
2 parents 6cd72e1 + f100d42 commit d3951ae

File tree

6 files changed

+21
-14
lines changed

6 files changed

+21
-14
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
![](logo.png)
1515

1616
## Deploying the Operator
17-
For version requirements see the [support matrix](./docs/source/support/releases.md).
17+
For version requirements see the [support matrix](https://operator.docs.scylladb.com/stable/support/releases.html).
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,17 +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-
* [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.
39+
* [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.
40+
* [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.
4141

4242
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/).
43+
* [Generic](https://operator.docs.scylladb.com/stable/installation/kubernetes/generic.html): Follow this guide for the general way to use the operator.
44+
* [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).
45+
* [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/).
4646
* [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.
4747

4848
## Releases
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).
49+
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).
5050

5151
## Documentation
5252
Scylla Operator documentation is available on https://operator.docs.scylladb.com
File renamed without changes.

docs/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Scylla Operator Documentation
2+
3+
Product documentation is available at the **[Documentation Site](https://operator.docs.scylladb.com/)**.
4+
5+
#### Developing the Documentation Site
6+
7+
Instructions to preview and build the documentation site are available in the [`README-dev.md`](./README-dev.md`) file.

docs/source/quickstarts/eks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ To deploy a ScyllaDB cluster please head to [our dedicated section on the topic]
3838

3939
## Accessing ScyllaDB
4040

41-
We also hve a whole section dedicated to [how you can access teh ScyllaDB cluster you've just created](../resources/scyllaclusters/clients/index.md).
41+
We also hve a whole section dedicated to [how you can access the ScyllaDB cluster you've just created](../resources/scyllaclusters/clients/index.md).
4242

4343
## Deleting the EKS cluster
4444

docs/source/quickstarts/gke.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ To deploy a ScyllaDB cluster please head to [our dedicated section on the topic]
6666

6767
## Accessing ScyllaDB
6868

69-
We also have a whole section dedicated to [how you can access teh ScyllaDB cluster you've just created](../resources/scyllaclusters/clients/index.md).
69+
We also have a whole section dedicated to [how you can access the ScyllaDB cluster you've just created](../resources/scyllaclusters/clients/index.md).
7070

7171
### Deleting a GKE cluster
7272

docs/source/resources/overview.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ kubectl explain --api-version='scylla.scylladb.com/v1alpha1' NodeConfig.spec
2323

2424
ScyllaCluster defines a ScyllaDB datacenter and manages the racks within.
2525
+++
26-
[Learn more »](/resources/scyllaclusters/basics)
26+
[Learn more »](./scyllaclusters/basics.md)
2727
:::
2828

2929
:::{grid-item-card} {material-round}`insights;2em` ScyllaDBMonitorings
3030
:link: /resources/scylladbmonitorings
3131

3232
ScyllaDBMonitoring defines and manages a ScyllaDB monitoring stack.
3333
+++
34-
[Learn more »](/resources/scylladbmonitorings)
34+
[Learn more »](./scylladbmonitorings.md)
3535
:::
3636

3737
::::
@@ -41,7 +41,7 @@ ScyllaDBMonitoring defines and manages a ScyllaDB monitoring stack.
4141
Cluster scoped resources declare the state for the whole cluster or control something at the cluster level which isn't multitenant.
4242
Therefore, working with these resources requires elevated privileges.
4343

44-
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`.
44+
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`.
4545

4646
::::{grid} 1 1 2 3
4747
:gutter: 4
@@ -51,15 +51,15 @@ Generally, there can be multiple instances of these resources but for some of th
5151

5252
NodeConfig manages setup and tuning for a set of Kubernetes nodes.
5353
+++
54-
[Learn more »](/resources/nodeconfigs)
54+
[Learn more »](./nodeconfigs.md)
5555
:::
5656

5757
:::{grid-item-card} {material-regular}`settings;2em` ScyllaOperatorConfigs
5858
:link: /resources/scyllaoperatorconfigs
5959

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

6565
::::

0 commit comments

Comments
 (0)