Move to generated API docs

scylladb · Dec 18, 2023 · 8fc1f38 · 8fc1f38
1 parent 2989206
commit 8fc1f38
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 193 deletions.
diff --git a/docs/source/generic.md b/docs/source/generic.md
@@ -77,7 +77,7 @@ kubectl -n scylla-operator logs deployment.apps/scylla-operator
 
 Now that the operator is running, we can create an instance of a Scylla cluster by creating an instance of the `clusters.scylla.scylladb.com` resource.
 Some of that resource's values are configurable, so feel free to browse `cluster.yaml` and tweak the settings to your liking.
-Full details for all the configuration options can be found in the [Scylla Cluster CRD documentation](scylla-cluster-crd.md).
+Full details for all the configuration options can be found in the [Scylla Cluster CRD documentation](api-reference/groups/scylla.scylladb.com/scyllaclusters.rst).
 
 When you are ready to create a Scylla cluster, simply run:
 

diff --git a/docs/source/helm.md b/docs/source/helm.md
@@ -163,7 +163,7 @@ racks:
 Above cluster will use 4.3.0 Scylla, 2.2.1 Scylla Manager Agent sidecar and will have a single rack having 2 nodes. 
 Each node will have a single CPU and 1 GiB of memory.
 
-For other customizable fields, please refer to [ScyllaCluster CRD definition](scylla-cluster-crd.md).
+For other customizable fields, please refer to [ScyllaCluster CRD](api-reference/groups/scylla.scylladb.com/scyllaclusters.rst).
 CRD Rack Spec and Helm Chart Rack should have the same fields.
 
 ### Installation

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -20,7 +20,7 @@ Scylla Operator Documentation
    upgrade
    releases
    support/index
-   scylla-cluster-crd
+   api-reference/index
    contributing
 
 Scylla Operator is an open source project which helps users of Scylla Open Source and Scylla Enterprise run Scylla on Kubernetes (K8s)
@@ -61,5 +61,5 @@ Currently it supports:
 * :doc:`Upgrade procedures <upgrade>`
 * :doc:`Releases <releases>`
 * :doc:`Support <support/index>`
-* :doc:`Scylla Cluster Custom Resource Definition (CRD) <scylla-cluster-crd>`
+* :doc:`API Reference <api-reference/index>`
 * :doc:`Contributing to the Scylla Operator Project <contributing>`
diff --git a/docs/source/manager.md b/docs/source/manager.md
@@ -160,7 +160,7 @@ Add following task definition to Cluster spec:
       interval: "1d"
 ```
 
-For full task definition configuration consult [Scylla Cluster CRD](scylla-cluster-crd.md).
+For full task definition configuration consult [ScyllaCluster CRD](api-reference/groups/scylla.scylladb.com/scyllaclusters.rst).
 
 **Note**: Scylla Manager Agent must have access to above bucket prior the update in order to schedule backup task.
 Consult Scylla Manager documentation for details on how to set it up.

diff --git a/docs/source/scylla-cluster-crd.md b/docs/source/scylla-cluster-crd.md