scylladb · dgarcia360 · Jul 20, 2022
diff --git a/docs/architecture/console-CL-full-demo.rst b/docs/architecture/console-CL-full-demo.rst
@@ -2,7 +2,7 @@ Consistency Level Console Demo
 ==============================
 In this demo, we'll bring up 3 nodes and demonstrate how writes and reads look, with tracing enabled in a cluster where our :term:`Replication Factor (RF)<Replication Factor (RF)>` is set to **3**.  We'll change the :term:`Consistency Level (CL)<Consistency Level (CL)>` between operations to show how messages are passed between nodes, and finally take down a few nodes to show failure conditions in a Scylla cluster.
 
-You can also learn more in the `High Availability lesson <https://university.scylladb.com/courses/scylla-essentials-overview/lessons/high-availability//>`_ on Scylla University.
+You can also learn more in the `High Availability lesson <https://university.scylladb.com/courses/scylla-essentials-overview/lessons/high-availability/>`_ on Scylla University.
 
 
 Note:  We use asciinema_ to generate the console casts used in this demo.  These asciicasts are more readable than embedded video, and allow you to copy the text or commands directly from the console to your clipboard.   We suggest viewing console casts in **fullscreen** to see the properly formatted output. 

diff --git a/docs/architecture/sstable/sstable3/sstables-3-data-file-format.rst b/docs/architecture/sstable/sstable3/sstables-3-data-file-format.rst
@@ -30,7 +30,7 @@ This document focuses on the data file format but also refers to other component
 
 Note that the file on-disk format applies both to the "mc" and "md" SSTable format versions.
 The "md" format only fixed the semantics of the (min|max)_clustering_key fields in the SSTable Statistics file, which are now valid for describing the accurate range of clustering prefixes present in the SSTable.
-See `SSTables 3.0 Statistics File Format <architecture/sstable/sstable3/sstables-3-statistics/>`_ for more details.
+See :doc:`SSTables 3.0 Statistics File Format </architecture/sstable/sstable3/sstables-3-statistics>` for more details.
 
 Overview
 ........

@@ -22,7 +22,7 @@ The basic steps are:
 * Send a PR or use ``git format-patch`` and ``git send-email`` to send to the list
 
 
-The entire process is `documented here <https://scylla.docs.scylladb.com/master/contribute/index>`_.
+The entire process is `documented here <https://github.com/scylladb/scylla/blob/master/CONTRIBUTING.md>`_.
 
 Contribute to Scylla Docs
 -------------------------

diff --git a/docs/getting-started/install-scylla/index.rst b/docs/getting-started/install-scylla/index.rst
@@ -29,7 +29,7 @@ Install Scylla
   * :doc:`Create a Scylla Cluster - Multi Data Center (DC) </operating-scylla/procedures/cluster-management/create-cluster-multidc/>`
   * :doc:`Scylla Developer Mode </getting-started/install-scylla/dev-mod>`
   * :doc:`Scylla Configuration Command Reference </getting-started/install-scylla/config-commands>`
-  * `Scylla Housekeeping and how to disable it <disable-housekeeping>`_
+  * :doc:`Scylla Housekeeping and how to disable it <disable-housekeeping>`
 
 
 

diff --git a/docs/getting-started/scylla-in-a-shared-environment.rst b/docs/getting-started/scylla-in-a-shared-environment.rst
@@ -69,10 +69,7 @@ Other Restrictions
 ------------------
 
 When starting up, Scylla will check the hardware and operating system
-configuration to verify that it is compatible with Scylla's performance requirements. See `developer mode`_ for more instructions.
-
-..  _`developer mode`: /getting-started/install-scylla/dev_mod/
-
+configuration to verify that it is compatible with Scylla's performance requirements. See :doc:`developer mode </getting-started/install-scylla/dev-mod>` for more instructions.
 
 Summary
 -------

@@ -89,7 +89,7 @@
 
 .. topic-box::
   :title: Scylla Alternator
-  :link: https://scylla.docs.scylladb.com/stable/alternator/alternator.html
+  :link: https://docs.scylladb.com/stable/alternator/alternator.html
   :image: /_static/img/mascots/scylla-alternator.svg
   :class: topic-box--product,large-3,small-6
 
@@ -113,7 +113,7 @@
 
 .. topic-box::
   :title: Scylla Drivers
-  :link: https://docs.scylladb.com/using-scylla/drivers/
+  :link: https://docs.scylladb.com/stable/using-scylla/drivers/
   :image: /_static/img/mascots/scylla-drivers.svg
   :class: topic-box--product,large-3,small-6
 

diff --git a/docs/kb/dpdk-hardware.rst b/docs/kb/dpdk-hardware.rst
@@ -33,5 +33,4 @@ Reference
 ---------
 `DPDK: Supported NICs <http://dpdk.org/doc/nics>`_
 
-`Knowledge Base 
-</kb/>`_
+:doc:`Knowledge Base </kb/index>`
diff --git a/docs/kb/gossip.rst b/docs/kb/gossip.rst
@@ -59,7 +59,7 @@ References
 
 `Gossip protocol on Wikipedia <https://en.wikipedia.org/wiki/Gossip_protocol>`_
 
-`Knowledge Base 
-</kb/>`_
+:doc:`Knowledge Base </kb/index>`
+
 
 .. include:: /rst_include/apache-copyrights.rst
diff --git a/docs/kb/memory-usage.rst b/docs/kb/memory-usage.rst
@@ -26,5 +26,5 @@ For example:
    SCYLLA_ARGS="--log-to-syslog 1 --log-to-stdout 0 --default-log-level info --collectd-address=127.0.0.1:25826 --collectd=1 --collectd-poll-period 3000 --network-stack posix --memory 2G --reserve-memory 2G
 
 
-`Knowledge Base 
-</kb/>`_
+:doc:`Knowledge Base </kb/index>`
+
diff --git a/docs/kb/ntp.rst b/docs/kb/ntp.rst
@@ -142,7 +142,7 @@ servers are working, have a look at the `instructions for joining the
 NTP pool <http://www.pool.ntp.org/join.html>`__ yourself, so that you
 can help share the correct time with others
 
-`Knowledge Base 
-</kb/>`_
+:doc:`Knowledge Base </kb/index>`
+
 
 .. include:: /rst_include/apache-copyrights.rst
diff --git a/docs/kb/posix.rst b/docs/kb/posix.rst
@@ -51,5 +51,5 @@ access <http://docs.datastax.com/en//cassandra/2.0/cassandra/security/secureFire
 `How to use, monitor, and disable transparent hugepages in Red Hat
 Enterprise Linux 6 <https://access.redhat.com/solutions/46111>`__
 
-`Knowledge Base 
-</kb/>`_
+:doc:`Knowledge Base </kb/index>`
+
diff --git a/docs/kb/quiz-administrators.rst b/docs/kb/quiz-administrators.rst
@@ -30,5 +30,5 @@ A: The acknowledgment will be sent to the user when two **local** replicas respo
 In this case, floor(local_RF/2 +1) = 2 , so LOCAL\_QUORUM is equal to RF per DC, which is why RF of 3 is usually better.
 
 
-`Knowledge Base 
-</kb/>`_
+:doc:`Knowledge Base </kb/index>`
+
diff --git a/docs/kb/scylla-and-spark-integration.rst b/docs/kb/scylla-and-spark-integration.rst
@@ -353,7 +353,8 @@ Scylla limitations
 
 For more compatibility information check `Scylla status <http://www.scylladb.com/technology/status/>`_
 
-`Knowledge Base 
-</kb/>`_
+:doc:`Knowledge Base </kb/index>`
+
+
 
 .. include:: /rst_include/apache-copyrights.rst
diff --git a/docs/operating-scylla/_common/networking-ports.rst b/docs/operating-scylla/_common/networking-ports.rst
@@ -27,4 +27,4 @@ Port    Description                                   Protocol
 19142   Native shard-aware transport port  (ssl)         TCP
 ======  ============================================  ========
 
-.. note:: For Scylla Manager ports, see `Scylla Manager <https://scylladb.github.io/scylla-manager/>`_.
+.. note:: For Scylla Manager ports, see `Scylla Manager <https://manager.docs.scylladb.com/>`.
diff --git a/docs/operating-scylla/admin-tools/sstable-index.rst b/docs/operating-scylla/admin-tools/sstable-index.rst
@@ -18,7 +18,7 @@ Where:
 * The ``--type`` or ``-t`` flag is used to specify the types making up the partition key of the table to which the index file belongs.
   This is needed so the tool can parse the SSTable keys found in the index. You will need to pass ``--type|-t`` for each type in the partition key.
   For the type names, the Cassandra type class notation has to be used. You can use the short form, i.e. without the org.apache.cassandra.db.marshal. prefix.
-  For a complete mapping of CQL types to their respective Cassandra type class notation, see `CQL3 Type Mapping <https://scylla.docs.scylladb.com/master/design-notes/cql3-type-mapping.html#cql3-type-mapping>`_.
+  For a complete mapping of CQL types to their respective Cassandra type class notation, see `CQL3 Type Mapping <https://github.com/scylladb/scylla/blob/master/docs/dev/cql3-type-mapping.md>`_.
 
 * The SSTable index file path can be passed both as a positional argument ``[path/to/scylla/datadir]``  or with the  ``--sstable`` flag.
 

diff --git a/docs/operating-scylla/admin.rst b/docs/operating-scylla/admin.rst
@@ -104,7 +104,7 @@ Compression between the client and the node is set by the driver that the applic
 
 For example:
 
-* `Scylla Python Driver <https://scylladb.github.io/python-driver/master/api/cassandra/cluster.html#cassandra.cluster.Cluster.compression>`_
+* `Scylla Python Driver <https://python-driver.docs.scylladb.com/master/api/cassandra/cluster.html#cassandra.cluster.Cluster.compression>`_
 * `Scylla Java Driver <https://github.com/scylladb/java-driver/tree/3.7.1-scylla/manual/compression>`_
 * `Go Driver <https://godoc.org/github.com/gocql/gocql#Compressor>`_
 
@@ -137,7 +137,7 @@ Networking
 
 .. image:: /operating-scylla/security/Scylla-Ports2.png
 
-The Scylla ports are detailed in the table below. For Scylla Manager ports, see the `Scylla Manager Documentation <https://scylladb.github.io/scylla-manager>`_.
+The Scylla ports are detailed in the table below. For Scylla Manager ports, see the `Scylla Manager Documentation <https://manager.docs.scylladb.com/>`_.
 
 .. include:: /operating-scylla/_common/networking-ports.rst
 

diff --git a/docs/operating-scylla/manager/2.1/add-a-cluster.rst b/docs/operating-scylla/manager/2.1/add-a-cluster.rst
@@ -96,9 +96,9 @@ Create a Managed Cluster
 
    You will see 3 tasks which are created by adding the cluster:
 
-   * Healthcheck - which checks the Scylla CQL, starting immediately, repeating every 15 seconds. See `Scylla Health Check <../health-check>`_
-   * Healthcheck REST - which checks the Scylla REST API, starting immediately, repeating every hour. See `Scylla Health Check <../health-check>`_
-   * Repair - an automated repair task, starting at midnight tonight, repeating every seven days at midnight. See `Run a Repair <../repair/>`_
+   * Healthcheck - which checks the Scylla CQL, starting immediately, repeating every 15 seconds. See :doc:`Scylla Health Check <health-check>`
+   * Healthcheck REST - which checks the Scylla REST API, starting immediately, repeating every hour. See :doc:`Scylla Health Check <health-check>`
+   * Repair - an automated repair task, starting at midnight tonight, repeating every seven days at midnight. See :doc:`Run a Repair <repair>`
 
    .. note:: If you want to change the schedule for the repair, see :ref:`Reschedule a repair <manager-2.1-reschedule-a-repair>`.
 
@@ -127,7 +127,7 @@ Although Scylla Manager is aware of all topology changes made within every clust
 
 **Procedure**
 
-#. `Add Scylla Manager Agent <../install-agent>`_ to the new node. Use the **same** authentication token as you did for the other nodes in this cluster. Do not generate a new token. 
+#. :doc:`Add Scylla Manager Agent <install-agent>` to the new node. Use the **same** authentication token as you did for the other nodes in this cluster. Do not generate a new token. 
 
 #. Confirm the node / datacenter was added by checking its :ref:`status <sctool_status>`. From the node running the Scylla Manager server, run the ``sctool status`` command, using the name of the managed cluster.
 
@@ -156,7 +156,7 @@ There is no need to perform any action in Scylla Manager after removing a node o
 See Also
 ========
 
-* `sctool Reference <../sctool>`_
+* :doc:`sctool Reference <sctool>`
 * :doc:`Remove a node from a Scylla Cluster </operating-scylla/procedures/cluster-management/remove-node>` 
 * :doc:`Scylla Monitoring </operating-scylla/monitoring/index>`
 
diff --git a/docs/operating-scylla/manager/2.1/agent-configuration-file.rst b/docs/operating-scylla/manager/2.1/agent-configuration-file.rst
@@ -202,4 +202,4 @@ Advanced settings
 Additional resources
 ====================
 
-Scylla Manager `Configuration file <../configuration-file>`_
+Scylla Manager :doc:`Configuration file <configuration-file>`
diff --git a/docs/operating-scylla/manager/2.1/architecture.rst b/docs/operating-scylla/manager/2.1/architecture.rst
@@ -18,7 +18,7 @@ Scylla Manager consists of three components:
 * Agent - a small executable, installed on each Scylla node. The Server communicates with the Agent over REST HTTPS. The Agent communicates with the local Scylla node over the REST HTTP.
 
 The Server persists its data to a Scylla cluster that can run locally or run on an external cluster
-(see `Use a remote database for Scylla Manager <../use-a-remote-db>`_ for details).
+(see :doc:`Use a remote database for Scylla Manager <use-a-remote-db>` for details).
 
 Optionally (but recommended), you can add Scylla Monitoring Stack to enable reporting of Scylla Manager metrics and alerts. 
 
@@ -28,7 +28,7 @@ The diagram below presents a logical view of Scylla Manager with a remote backen
 Each node has two connections with the Scylla Manager Server:
 
 * REST API connection - used for Scylla Manager and Scylla Manager Agent activities
-* CQL connection - used for the Scylla `Health Check <../health-check>`_
+* CQL connection - used for the Scylla :doc:`Health Check <health-check>`
 
 Scylla Manager uses the following ports:
 
@@ -52,6 +52,6 @@ Port    Description                                   Protocol
 Additional Resources
 ====================
 
-* `Install Scylla Manager <../install>`_
-* `Install Scylla Manager Agent <../install-agent>`_
-* `sctool Reference <../sctool>`_
+* :doc:`Install Scylla Manager <install>`
+* :doc:`Install Scylla Manager Agent <install-agent>`
+* :doc:`sctool Reference <sctool>`
diff --git a/docs/operating-scylla/manager/2.1/configuration-file.rst b/docs/operating-scylla/manager/2.1/configuration-file.rst
@@ -70,7 +70,7 @@ Logging settings specify log output and level.
 Database settings
 =================
 
-Database settings allow for `using a remote cluster <../use-a-remote-db>`_ to store Scylla Manager data.
+Database settings allow for :doc:`using a remote cluster <use-a-remote-db>` to store Scylla Manager data.
 
 .. code-block:: yaml
 
@@ -139,6 +139,8 @@ Backup settings let you specify backup parameters.
    # Zero means no limit.
    #  age_max: 12h
 
+.. _repair-settings:
+
 Repair settings
 ===============
 

diff --git a/docs/operating-scylla/manager/2.1/extract-schema-from-backup.rst b/docs/operating-scylla/manager/2.1/extract-schema-from-backup.rst
@@ -8,7 +8,7 @@ Extract schema from the backup
 
 The first step to restoring a Scylla Manager backup is to restore the CQL schema from a text file.
 Scylla Manager version 2.1 creates a backup up of matching schema along with the snapshot.
-If you created the backup with Scylla Manager version 2.0 or you didn't provide credentials for a schema backup in Scylla Manager version 2.1, follow the instructions in `how to restore your schema from system table <../../2.0/extract-schema-from-system-table/>`_.
+If you created the backup with Scylla Manager version 2.0 or you didn't provide credentials for a schema backup in Scylla Manager version 2.1, follow the instructions in how to restore your schema from system table(deleted document).
 
 If not, follow these steps to restore the schema from the Scylla Manager backup that has the schema stored along with the snapshot:
 

diff --git a/docs/operating-scylla/manager/2.1/install-agent.rst b/docs/operating-scylla/manager/2.1/install-agent.rst
@@ -178,4 +178,4 @@ Adding the cluster to Scylla Manager automatically creates a backup task. Valida
 Register a cluster
 ------------------
 
-Continue with `Add a Cluster <../add-a-cluster>`_.
+Continue with :doc:`Add a Cluster <add-a-cluster>`.
diff --git a/docs/operating-scylla/manager/2.1/install.rst b/docs/operating-scylla/manager/2.1/install.rst
@@ -55,7 +55,7 @@ It can be run in non-interactive mode if you'd like to script it.
 There are three decisions you need to make:
 
 * Do you want to enable the service to start automatically? If not, you will have to start the service manually each time you want to use it.
-* Do you want to set up and enable a local Scylla backend? If not, you will need to set up a `remote DB <../use-a-remote-db>`_
+* Do you want to set up and enable a local Scylla backend? If not, you will need to set up a :doc:`remote DB <use-a-remote-db>`
 * Do you want Scylla Manager to check periodically if updates are available? If not, you will need to check yourself.
 
 .. code-block:: none
@@ -129,4 +129,4 @@ Scylla Manager integrates with ``systemd`` and can be started and stopped using
 Install Scylla Manager Agent
 ============================
 
-Continue with `Setup Scylla Manager Agent <../install-agent>`_
+Continue with :doc:`Setup Scylla Manager Agent <install-agent>`
diff --git a/docs/operating-scylla/manager/2.1/repair.rst b/docs/operating-scylla/manager/2.1/repair.rst
@@ -116,7 +116,7 @@ When scheduling repair, you may specify ``--intensity`` flag, the intensity mean
 * For values > 1 intensity specifies the number of segments repaired by Scylla in a single repair command. Higher values result in higher speed and may increase cluster load.
 * For values < 1 intensity specifies what percent of node's shards repaired in parallel.
 * For intensity equal to 1 it will repair one segment in each repair command on all shards in parallel.
-* For zero intensity it uses limits specified in Scylla Manager `configuration <../configuration-file#repair-settings>`_.
+* For zero intensity it uses limits specified in Scylla Manager :ref:`configuration <repair-settings>`.
 
   Please note that this only works with versions that are **not** :doc:`row-level-repair enabled </upgrade/upgrade-manager/upgrade-guide-from-2.x.a-to-2.y.b/upgrade-row-level-repair>`.
 

diff --git a/docs/operating-scylla/manager/2.1/restore-a-backup.rst b/docs/operating-scylla/manager/2.1/restore-a-backup.rst
@@ -40,7 +40,7 @@ If you need help, you can check official documentation on :doc:`operational proc
 Install Scylla Manager
 ----------------------
 
-You need a working Scylla Manager setup to list backups. If you don't have it installed, please follow official instructions on `how to install Scylla Manager <../install/>`_ first.
+You need a working Scylla Manager setup to list backups. If you don't have it installed, please follow official instructions on :doc:`how to install Scylla Manager <install>` first.
 
 Nodes must have access to the locations of the backups as per instructions in the official documentation for :ref:`installing Scylla Manager Agent <manager-2.1-prepare-nodes-for-backup>`.
 
@@ -111,7 +111,7 @@ Restore the schema
 ------------------
 
 Scylla Manager 2.1 can store schema with your backup.
-To extract schema files for each keyspace from the backup, please refer to the official documentation for `extracting schema from the backup <../../2.1/extract-schema-from-backup>`_. For convenience, here is the continuation of our example with the list of steps for restoring schema:
+To extract schema files for each keyspace from the backup, please refer to the official documentation for :doc:`extracting schema from the backup <extract-schema-from-backup>`. For convenience, here is the continuation of our example with the list of steps for restoring schema:
 
 #. Download schema from the backup store to the current dir. It's in the first line of the ``backup_files.out`` output:
 

diff --git a/docs/operating-scylla/manager/2.1/sctool.rst b/docs/operating-scylla/manager/2.1/sctool.rst
@@ -225,7 +225,7 @@ Example: backup
 This example backs up the entire cluster named prod-cluster.
 The backup begins on December 9, 2019 at 16:05 and will repeat at this time every 24 hours.
 The backup is stored in s3 in a directory named ``my-backups``.
-Additional examples are available in `Backup Scylla Clusters <../backup/>`_
+Additional examples are available in :doc:`Backup Scylla Clusters <backup>`
 
 .. code-block:: none
 
@@ -433,7 +433,7 @@ From this information we know the following:
 * Delimiter - whitespace character (ie '  ')
 * Keyspace / table name - system_sec/table
 
-See `Restore <restore>`_ on information how to use these files to restore a backup.
+See :doc:`Restore </operating-scylla/procedures/backup-restore/restore>` on information how to use these files to restore a backup.
 
 backup delete
 =============
@@ -516,7 +516,7 @@ This command adds the specified cluster to the manager.
 Once a Scylla cluster is added, a weekly repair task is also added.
 
 Before continuing, make sure the cluster that you want to add is prepared for it,
-see `Add a cluster to Scylla Manager <../add-a-cluster>`_ for instructions.
+see :doc:`Add a cluster to Scylla Manager <add-a-cluster>` for instructions.
 
 **Syntax:**
 
@@ -539,7 +539,7 @@ Example: cluster add
 ....................
 
 This example is only the command that you use to add the cluster to Scylla Manager, not the entire procedure for adding a cluster.
-The procedure is detailed in `Add a cluster to Scylla Manager <../add-a-cluster>`_.
+The procedure is detailed in :doc:`Add a cluster to Scylla Manager <add-a-cluster>`.
 
 .. code-block:: none
 

diff --git a/docs/operating-scylla/monitoring/2.4/monitor-without-docker.2.1.rst b/docs/operating-scylla/monitoring/2.4/monitor-without-docker.2.1.rst
@@ -1,7 +1,7 @@
 Deploying Scylla Monitoring Without Docker
 ==========================================
 
-The following instructions will help to deploy `Scylla Monitoring Stack <../monitoring-stack>`_ in the case you can not use the docker version.
+The following instructions will help to deploy :doc:`Scylla Monitoring Stack <monitoring-stack>` in the case you can not use the docker version.
 
 Please note, Scylla recommends you use the docker version as it will provide you with most updated, current scylla monitoring system.
 

diff --git a/docs/operating-scylla/monitoring/3.0/monitor-without-docker.rst b/docs/operating-scylla/monitoring/3.0/monitor-without-docker.rst
@@ -1,7 +1,7 @@
 Deploying Scylla Monitoring Without Docker
 ==========================================
 
-The following instructions will help to deploy `Scylla Monitoring Stack <../monitoring-stack>`_ in cases where you can not use the recommended Docker version.
+The following instructions will help to deploy :doc:`Scylla Monitoring Stack <monitoring-stack>` in cases where you can not use the recommended Docker version.
 
 Please note, Scylla recommends you use the Docker version as it will provide you with the most updated, current Scylla Monitoring system.