Update cockroachcloud/ links to use Liquid syntax (#18844)

Fixes DOC-10953
cockroachdb · Aug 21, 2024 · 4018a61 · 4018a61
1 parent 1d5d044
commit 4018a61
Show file tree

Hide file tree

Showing 223 changed files with 471 additions and 471 deletions.
diff --git a/src/current/cockroachcloud/alerts-page.md b/src/current/cockroachcloud/alerts-page.md
@@ -23,7 +23,7 @@ The **Alerts** page is applicable for CockroachDB {{ site.data.products.dedicate
 
 ### CMEK
 
-The [Customer-Managed Encryption Keys (CMEK)](https://www.cockroachlabs.com/docs/cockroachcloud/cmek) alert is triggered when the cluster node is unable to start due to CMEK key access failure.
+The [Customer-Managed Encryption Keys (CMEK)]({% link cockroachcloud/cmek.md %}) alert is triggered when the cluster node is unable to start due to CMEK key access failure.
 {% comment %}- Encrypted backup failed due to CMEK key access failure.{% endcomment %}
 
 If you receive the alert repeatedly, verify the following:

diff --git a/src/current/cockroachcloud/egress-perimeter-controls.md b/src/current/cockroachcloud/egress-perimeter-controls.md
@@ -35,7 +35,7 @@ Regardless of user-specific Egress Perimeter Control policy, egress is always pe
 ## Before you begin
 
 - Egress Perimeter Controls are supported on AWS and GCP for the following deployment types:
-    - CockroachDB {{ site.data.products.dedicated }} advanced with [PCI-ready features](https://www.cockroachlabs.com/docs/cockroachcloud/cluster-management#configure-pci-ready-features-dedicated-advanced).
+    - CockroachDB {{ site.data.products.dedicated }} advanced with [PCI-ready features]({% link cockroachcloud/cluster-management.md %}#configure-pci-ready-features-dedicated-advanced).
     - CockroachDB {{ site.data.products.dedicated }} [Private Cluster]({% link cockroachcloud/private-clusters.md %}).
 
     Egress Perimeter Controls are not supported for CockroachDB {{ site.data.products.dedicated }} on Azure or for CockroachDB {{ site.data.products.serverless }}.

diff --git a/src/current/cockroachcloud/serverless-cluster-management.md b/src/current/cockroachcloud/serverless-cluster-management.md
@@ -23,7 +23,7 @@ For each cluster, the following details display:
 - The **Version** of CockroachDB the cluster is running
 - The **Action** button, which is used to:
     - [**Edit cluster**](#edit-cluster-capacity)
-    - [**Move cluster**](https://www.cockroachlabs.com/docs/cockroachcloud/folders#move-a-cluster-into-or-out-of-a-folder)
+    - [**Move cluster**]({% link cockroachcloud/folders.md %}#move-a-cluster-into-or-out-of-a-folder)
     - [**Delete cluster**](#delete-cluster)
     - **Get support**
 

diff --git a/src/current/v23.1/api-support-policy.md b/src/current/v23.1/api-support-policy.md
@@ -82,8 +82,8 @@ A *mixed* API includes both stable and unstable features.
 | [Cluster API]({% link {{ page.version.version }}/cluster-api.md %})                                         | Mixed    | [Versioned independently from CockroachDB.]({% link {{ page.version.version }}/cluster-api.md %}#versioning-and-stability) | For information on supported endpoints, see [Cluster API]({% link {{ page.version.version }}/cluster-api.md %}).                                                                                                                                               | CockroachDB {{ site.data.products.dedicated }}, CockroachDB {{ site.data.products.core }} |
 | [DB Console]({% link {{ page.version.version }}/ui-overview.md %})                                          | Unstable | N/A                                                                                    | For stable access to the information present in this tool, use the [Cluster API]({% link {{ page.version.version }}/cluster-api.md %}).                                                                                                                        | CockroachDB {{ site.data.products.dedicated }}, CockroachDB {{ site.data.products.core }} |
 | [Logging]({% link {{ page.version.version }}/logging-overview.md %})                                        | Mixed    | Versioned concurrently with CockroachDB.                                               | Stability varies by [event type]({% link {{ page.version.version }}/eventlog.md %}). Structured events are stable and unstructured events are unstable.                                                                                                        | CockroachDB {{ site.data.products.dedicated }}, CockroachDB {{ site.data.products.core }} |
-| [`ccloud` CLI](https://www.cockroachlabs.com/docs/cockroachcloud/ccloud-get-started)               | Mixed    | Versioned independently from CockroachDB.                                              | Default output is unstable. Specify the `–json` argument in the CLI for stable output that follows the versioning scheme.                                                                                                  | CockroachDB {{ site.data.products.cloud }}                                       |
-| [CockroachDB {{ site.data.products.cloud }} API](https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api)     | Stable   | Versioned independently from CockroachDB.                                              |                                                                                                                                                                                                                            | CockroachDB {{ site.data.products.cloud }}                                       |
+| [`ccloud` CLI]({% link cockroachcloud/ccloud-get-started.md %})               | Mixed    | Versioned independently from CockroachDB.                                              | Default output is unstable. Specify the `–json` argument in the CLI for stable output that follows the versioning scheme.                                                                                                  | CockroachDB {{ site.data.products.cloud }}                                       |
+| [CockroachDB {{ site.data.products.cloud }} API]({% link cockroachcloud/cloud-api.md %})     | Stable   | Versioned independently from CockroachDB.                                              |                                                                                                                                                                                                                            | CockroachDB {{ site.data.products.cloud }}                                       |
 | CockroachDB {{ site.data.products.cloud }} Console                                     | Unstable | N/A                                                                                    |                                                                                                                                                                                                                            | CockroachDB {{ site.data.products.cloud }}                                       |
 | [Advanced Debug endpoints]({% link {{ page.version.version }}/ui-debug-pages.md %})                         | Reserved | N/A                                                                                    |                                                                                                                                                                                                                            | N/A                                                               |
 

diff --git a/src/current/v23.1/authorization.md b/src/current/v23.1/authorization.md
@@ -7,12 +7,12 @@ docs_area: manage
 
 This page documents procedures for managing the lifecycle of SQL users and roles on CockroachDB clusters.
 
-Procedures for managing access are covered in [Managing Access in CockroachDB {{ site.data.products.cloud }}](https://www.cockroachlabs.com/docs/cockroachcloud/managing-access).
+Procedures for managing access are covered in [Managing Access in CockroachDB {{ site.data.products.cloud }}]({% link cockroachcloud/managing-access.md %}).
 
 {{site.data.alerts.callout_info}}
 The concept of *Organization user* is distinct from Authorization of *SQL user/role* on clusters is distinct from authorization of CockroachDB {{ site.data.products.cloud }} users within CockroachDB {{ site.data.products.cloud }} organizations.
 
-Learn more: [Overview of the CockroachDB Cloud authorization model](https://www.cockroachlabs.com/docs/cockroachcloud/authorization#overview-of-the-cockroachdb-cloud-two-level-authorization-model)
+Learn more: [Overview of the CockroachDB Cloud authorization model]({% link cockroachcloud/authorization.md %}#overview-of-the-cockroachdb-cloud-authorization-model)
 {{site.data.alerts.end}}
 
 

diff --git a/src/current/v23.1/aws-dms.md b/src/current/v23.1/aws-dms.md
@@ -39,7 +39,7 @@ Complete the following items before starting the DMS migration:
 
     This prevents a potential issue when migrating especially large tables with millions of rows.
 
-- Manually create all schema objects in the target CockroachDB cluster. If you are migrating from PostgreSQL, MySQL, Oracle, or Microsoft SQL Server, you can [use the **Schema Conversion Tool**](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page) to convert and export your schema.
+- Manually create all schema objects in the target CockroachDB cluster. If you are migrating from PostgreSQL, MySQL, Oracle, or Microsoft SQL Server, you can [use the **Schema Conversion Tool**]({% link cockroachcloud/migrations-page.md %}) to convert and export your schema.
 
     - All tables must have an explicitly defined primary key. For more guidance, see the [Migration Overview]({% link {{ page.version.version }}/migration-overview.md %}#schema-design-best-practices).
 
@@ -215,7 +215,7 @@ If your migration failed for some reason, you can check the checkbox next to the
 
 ### AWS PrivateLink
 
-If using CockroachDB {{ site.data.products.dedicated }}, you can enable [AWS PrivateLink](https://aws.amazon.com/privatelink/) to securely connect your AWS application with your CockroachDB {{ site.data.products.dedicated }} cluster using a private endpoint. To configure AWS PrivateLink with CockroachDB {{ site.data.products.dedicated }}, see [Network Authorization](https://www.cockroachlabs.com/docs/cockroachcloud/network-authorization#aws-privatelink).
+If using CockroachDB {{ site.data.products.dedicated }}, you can enable [AWS PrivateLink](https://aws.amazon.com/privatelink/) to securely connect your AWS application with your CockroachDB {{ site.data.products.dedicated }} cluster using a private endpoint. To configure AWS PrivateLink with CockroachDB {{ site.data.products.dedicated }}, see [Network Authorization]({% link cockroachcloud/network-authorization.md %}#aws-privatelink).
 
 ### `BatchApplyEnabled`
 
@@ -413,7 +413,7 @@ The `BatchApplyEnabled` setting can improve replication performance and is recom
 ## See Also
 
 - [Migration Overview]({% link {{ page.version.version }}/migration-overview.md %})
-- [Schema Conversion Tool](https://www.cockroachlabs.com/docs/cockroachcloud/migrations-page)
+- [Schema Conversion Tool]({% link cockroachcloud/migrations-page.md %})
 - [`cockroach demo`]({% link {{ page.version.version }}/cockroach-demo.md %})
 - [AWS DMS documentation](https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html)
 - [Client connection parameters]({% link {{ page.version.version }}/connection-parameters.md %})

diff --git a/src/current/v23.1/backup-and-restore-monitoring.md b/src/current/v23.1/backup-and-restore-monitoring.md
@@ -18,7 +18,7 @@ We recommend setting up monitoring to alert when anomalies occur. You can then u
 - [`SHOW JOBS`]({% link {{ page.version.version }}/show-jobs.md %})
 - [`SHOW BACKUP`]({% link {{ page.version.version }}/show-backup.md %})
 
-For detail on [managed-service backups](https://www.cockroachlabs.com/docs/cockroachcloud/use-managed-service-backups) that Cockroach Labs stores for your CockroachDB {{ site.data.products.cloud }} cluster, see the **Backup and Restore** page in the Cloud Console.
+For detail on [managed-service backups]({% link cockroachcloud/use-managed-service-backups.md %}) that Cockroach Labs stores for your CockroachDB {{ site.data.products.cloud }} cluster, see the **Backup and Restore** page in the Cloud Console.
 
 {% include {{ page.version.version }}/backups/metrics-per-node.md %}
 
@@ -68,8 +68,8 @@ Metric | Description
 
 To use the Datadog integration with your **CockroachDB {{ site.data.products.dedicated }}** cluster, you can:
 
-- Export the following schedule backup metrics to Datadog using the [Cloud API](https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api). To set this up, see [Export Metrics From a CockroachDB Dedicated Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics?filters=datadog-metrics-export).
-- Access the Cloud Console **Monitoring** page to enable the integration. To set this up, see [Monitor CockroachDB Dedicated with Datadog](https://www.cockroachlabs.com/docs/cockroachcloud/tools-page#monitor-cockroachdb-dedicated-with-datadog).
+- Export the following schedule backup metrics to Datadog using the [Cloud API]({% link cockroachcloud/cloud-api.md %}). To set this up, see [Export Metrics From a CockroachDB Dedicated Cluster](https://www.cockroachlabs.com/docs/cockroachcloud/export-metrics?filters=datadog-metrics-export).
+- Access the Cloud Console **Monitoring** page to enable the integration. To set this up, see [Monitor CockroachDB Dedicated with Datadog]({% link cockroachcloud/tools-page.md %}#monitor-cockroachdb-dedicated-with-datadog).
 
 ### Available metrics in Datadog
 

diff --git a/src/current/v23.1/backup.md b/src/current/v23.1/backup.md
@@ -32,7 +32,7 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO
 
 ## Considerations
 
-- Core users can only take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups). To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). You can also use [CockroachDB {{ site.data.products.dedicated }}](https://cockroachlabs.cloud/signup?referralId=docs-crdb-backup), which runs [full backups daily and incremental backups hourly](https://www.cockroachlabs.com/docs/cockroachcloud/use-managed-service-backups).
+- Core users can only take [full backups]({% link {{ page.version.version }}/take-full-and-incremental-backups.md %}#full-backups). To use the other backup features, you need an [Enterprise license]({% link {{ page.version.version }}/enterprise-licensing.md %}). You can also use [CockroachDB {{ site.data.products.dedicated }}](https://cockroachlabs.cloud/signup?referralId=docs-crdb-backup), which runs [full backups daily and incremental backups hourly]({% link cockroachcloud/use-managed-service-backups.md %}).
 - [Full cluster backups](#back-up-a-cluster) include [Enterprise license keys]({% link {{ page.version.version }}/enterprise-licensing.md %}). When you [restore]({% link {{ page.version.version }}/restore.md %}) a full cluster backup that includes an Enterprise license, the Enterprise license is also restored.
 - [Zone configurations]({% link {{ page.version.version }}/configure-replication-zones.md %}) present on the destination cluster prior to a restore will be **overwritten** during a [cluster restore]({% link {{ page.version.version }}/restore.md %}#full-cluster) with the zone configurations from the [backed up cluster](#back-up-a-cluster). If there were no customized zone configurations on the cluster when the backup was taken, then after the restore the destination cluster will use the zone configuration from the [`RANGE DEFAULT` configuration]({% link {{ page.version.version }}/configure-replication-zones.md %}#view-the-default-replication-zone).
 - You cannot restore a backup of a multi-region database into a single-region database.

diff --git a/src/current/v23.1/bulk-delete-data.md b/src/current/v23.1/bulk-delete-data.md
@@ -33,7 +33,7 @@ Exercise caution when batch deleting rows from tables with foreign key constrain
 
 Before reading this page, do the following:
 
-- [Create a CockroachDB {{ site.data.products.serverless }} cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local).
+- [Create a CockroachDB {{ site.data.products.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local).
 - [Install a Driver or ORM Framework]({% link {{ page.version.version }}/install-client-drivers.md %}).
 - [Connect to the database]({% link {{ page.version.version }}/connect-to-the-database.md %}).
 - [Insert data]({% link {{ page.version.version }}/insert-data.md %}) that you now want to delete.

diff --git a/src/current/v23.1/bulk-update-data.md b/src/current/v23.1/bulk-update-data.md
@@ -19,7 +19,7 @@ Exercise caution when batch-updating rows from tables with foreign key constrain
 
 Before reading this page, do the following:
 
-- [Create a CockroachDB {{ site.data.products.serverless }} cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local).
+- [Create a CockroachDB {{ site.data.products.serverless }} cluster]({% link cockroachcloud/quickstart.md %}) or [start a local cluster](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart?filters=local).
 - [Install a Driver or ORM Framework]({% link {{ page.version.version }}/install-client-drivers.md %}).
 
     For the example on this page, we use the `psycopg2` Python driver.

diff --git a/src/current/v23.1/choose-a-deployment-option.md b/src/current/v23.1/choose-a-deployment-option.md
@@ -99,7 +99,7 @@ Cockroach Labs offers four ways to deploy CockroachDB: three managed services&md
 
 - [CockroachDB deployment]({% link {{ page.version.version }}/architecture/glossary.md %}#cockroachdb-deployment-terms)
 - [CockroachDB pricing](https://www.cockroachlabs.com/get-started-cockroachdb/)
-- [CockroachDB Cloud FAQs](https://www.cockroachlabs.com/docs/cockroachcloud/serverless-faqs)
-- [CockroachDB Cloud Architecture](https://www.cockroachlabs.com/docs/cockroachcloud/architecture)
+- [CockroachDB Cloud FAQs]({% link cockroachcloud/serverless-faqs.md %})
+- [CockroachDB Cloud Architecture]({% link cockroachcloud/architecture.md %})
 - [Manual Deployment]({% link {{ page.version.version }}/manual-deployment.md %})
 - [Kubernetes Deployment]({% link {{ page.version.version }}/kubernetes-overview.md %})
diff --git a/src/current/v23.1/cloud-storage-authentication.md b/src/current/v23.1/cloud-storage-authentication.md
@@ -268,7 +268,7 @@ Construct the ARN for your identity role. You will need this to add into the Tru
 arn:aws:iam::{AWS account ID}:role/crl-dr-store-user-{cluster ID suffix}
 ~~~
 
-You can find the AWS account ID and your cluster's ID using the [Cloud API](https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api):
+You can find the AWS account ID and your cluster's ID using the [Cloud API]({% link cockroachcloud/cloud-api.md %}):
 
 {% include_cached copy-clipboard.html %}
 ~~~shell
@@ -580,7 +580,7 @@ Construct the service account name for your identity service account. You will n
 crl-dr-store-user-{cluster id suffix}@{project id}.iam.gserviceaccount.com
 ~~~
 
-You can find the GCP project ID and your cluster's ID using the [Cloud API](https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api):
+You can find the GCP project ID and your cluster's ID using the [Cloud API]({% link cockroachcloud/cloud-api.md %}):
 
 {% include_cached copy-clipboard.html %}
 ~~~shell

diff --git a/src/current/v23.1/common-issues-to-monitor.md b/src/current/v23.1/common-issues-to-monitor.md
@@ -327,4 +327,4 @@ Because each node needs to update a liveness record on disk, maxing out disk ban
 - [Troubleshoot SQL Behavior]({% link {{ page.version.version }}/query-behavior-troubleshooting.md %})
 - [Admission Control]({% link {{ page.version.version }}/admission-control.md %})
 - [Metrics]({% link {{ page.version.version }}/metrics.md %})
-- [Alerts Page](https://www.cockroachlabs.com/docs/cockroachcloud/alerts-page) (CockroachDB {{ site.data.products.dedicated }})
+- [Alerts Page]({% link cockroachcloud/alerts-page.md %}) (CockroachDB {{ site.data.products.dedicated }})
diff --git a/src/current/v23.1/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.md b/src/current/v23.1/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.md
@@ -22,7 +22,7 @@ An overview of the workflow involves:
 Before starting this tutorial, you will need:
 
 - A CockroachDB cluster. You can use a CockroachDB {{ site.data.products.cloud }} or CockroachDB {{ site.data.products.core }} cluster.
-    - If you are using CockroachDB {{ site.data.products.serverless }} or CockroachDB {{ site.data.products.dedicated }}, see the [Quickstart with CockroachDB](https://www.cockroachlabs.com/docs/cockroachcloud/quickstart) guide. For CockroachDB {{ site.data.products.core }} clusters, see the [install]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}) page.
+    - If you are using CockroachDB {{ site.data.products.serverless }} or CockroachDB {{ site.data.products.dedicated }}, see the [Quickstart with CockroachDB]({% link cockroachcloud/quickstart.md %}) guide. For CockroachDB {{ site.data.products.core }} clusters, see the [install]({% link {{ page.version.version }}/install-cockroachdb-mac.md %}) page.
 - An [Okta Developer account](https://developer.okta.com/signup/).
 - (Optional) A Kafka cluster. This tutorial includes [Kafka cluster setup](#step-3-create-a-kafka-sink). Note that this tutorial was tested with Kafka [version 2.8.2](https://kafka.apache.org/downloads). The Kafka cluster configuration may vary with different versions, but the Okta setup and changefeed creation will be the same.