-
Notifications
You must be signed in to change notification settings - Fork 459
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Fixes DOC-8113 What this PR does: - For all docs that have links pointing to the same folder (e.g., v23.1, cockroachcloud, releases), use `{% link path/to/page.md %}`. - For all docs that have links pointing to a different folder, use the fully qualified URL (e.g., `https://www.cockroachlabs.com/docs/releases/v23.1`). This is because we'll eventually be breaking off each folder into its own microsite, so rather than update the link twice, we just update it once. - For any reference to `/{{ site.versions["stable"] }}/` or `/stable/` within links in cockroachcloud only, we replace it with `/{{ site.current_cloud_version }}/`. - Updated all advisories page to point links to docs to the latest applicable version to the tech advisory instead of stable docs. - Updated all releases pages to point links to the docs of the same version as the release instead of the stable docs. - Moved all HTML comments to Liquid comments, as the contents of HTML comments both get parsed by the Liquid parser and appear on the production site.
- Loading branch information
1 parent
a8ca78b
commit 35f3263
Showing
1,403 changed files
with
20,182 additions
and
19,460 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,8 @@ | ||
You might also be interested in the following pages: | ||
|
||
- [Client Connection Parameters](../{{site.current_cloud_version}}/connection-parameters.html) | ||
- [Data Replication](../{{site.current_cloud_version}}/demo-data-replication.html) | ||
- [Fault Tolerance & Recovery](../{{site.current_cloud_version}}/demo-fault-tolerance-and-recovery.html) | ||
- [Automatic Rebalancing](../{{site.current_cloud_version}}/demo-automatic-rebalancing.html) | ||
- [Cross-Cloud Migration](../{{site.current_cloud_version}}/demo-automatic-cloud-migration.html) | ||
- [Automated Operations](../{{site.current_cloud_version}}/orchestrate-a-local-cluster-with-kubernetes-insecure.html) | ||
- [Client Connection Parameters](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/connection-parameters) | ||
- [Data Replication](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/demo-data-replication) | ||
- [Fault Tolerance & Recovery](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/demo-fault-tolerance-and-recovery) | ||
- [Automatic Rebalancing](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/demo-automatic-rebalancing) | ||
- [Cross-Cloud Migration](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/demo-automatic-cloud-migration) | ||
- [Automated Operations](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/orchestrate-a-local-cluster-with-kubernetes-insecure) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
CockroachDB supports two types of backups: | ||
|
||
- **Managed-service backups**: Cockroach Labs takes automated backups of {{ site.data.products.serverless }} and {{ site.data.products.dedicated }} clusters that are stored in Cockroach Labs' cloud storage. {% if page.name != "use-managed-service-backups.md" %} See [Use Managed-Service Backups](../cockroachcloud/use-managed-service-backups.html) to learn more about the type and frequency of backups supported for both {{ site.data.products.db }} clusters. {% else %} {% endif %} | ||
- {% if page.name == "take-and-restore-customer-owned-backups.md" %} **Customer-owned backups**: {% else %} **[Customer-owned backups](../cockroachcloud/take-and-restore-customer-owned-backups.html)**: {% endif %} You can take manual backups and store them in your [cloud storage buckets](../{{site.versions["stable"]}}/use-cloud-storage.html) using the [`BACKUP`](../{{site.versions["stable"]}}/backup.html) statement. Customer-owned backups are supported in {{ site.data.products.serverless }}, {{ site.data.products.dedicated }}, and {{ site.data.products.core }}. | ||
- **Managed-service backups**: Cockroach Labs takes automated backups of {{ site.data.products.serverless }} and {{ site.data.products.dedicated }} clusters that are stored in Cockroach Labs' cloud storage. {% if page.name != "use-managed-service-backups.md" %} See [Use Managed-Service Backups]({% link cockroachcloud/use-managed-service-backups.md %}) to learn more about the type and frequency of backups supported for both {{ site.data.products.db }} clusters. {% else %} {% endif %} | ||
- {% if page.name == "take-and-restore-customer-owned-backups.md" %} **Customer-owned backups**: {% else %} **[Customer-owned backups]({% link cockroachcloud/take-and-restore-customer-owned-backups.md %})**: {% endif %} You can take manual backups and store them in your [cloud storage buckets](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/use-cloud-storage) using the [`BACKUP`](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/backup) statement. Customer-owned backups are supported in {{ site.data.products.serverless }}, {{ site.data.products.dedicated }}, and {{ site.data.products.core }}. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
{{site.data.alerts.callout_info}} | ||
To determine how wide the columns need to be, the default `table` display format in `cockroach sql` buffers the results it receives from the server before printing them to the console. When consuming core changefeed data using `cockroach sql`, it's important to use a display format like `csv` that does not buffer its results. To set the display format, use the [`--format=csv` flag](../{{site.current_cloud_version}}/cockroach-sql.html#sql-flag-format) when starting the [built-in SQL client](../{{site.current_cloud_version}}/cockroach-sql.html), or set the [`\set display_format=csv` option](../{{site.current_cloud_version}}/cockroach-sql.html#client-side-options) once the SQL client is open. | ||
To determine how wide the columns need to be, the default `table` display format in `cockroach sql` buffers the results it receives from the server before printing them to the console. When consuming core changefeed data using `cockroach sql`, it's important to use a display format like `csv` that does not buffer its results. To set the display format, use the [`--format=csv` flag](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/cockroach-sql#sql-flag-format) when starting the [built-in SQL client](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/cockroach-sql), or set the [`\set display_format=csv` option](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/cockroach-sql#client-side-options) once the SQL client is open. | ||
{{site.data.alerts.end}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
{{site.data.alerts.callout_info}} | ||
Because core changefeeds return results differently than other SQL statements, they require a dedicated database connection with specific settings around result buffering. In normal operation, CockroachDB improves performance by buffering results server-side before returning them to a client; however, result buffering is automatically turned off for core changefeeds. Core changefeeds also have different cancellation behavior than other queries: they can only be canceled by closing the underlying connection or issuing a [`CANCEL QUERY`](../{{site.current_cloud_version}}/cancel-query.html) statement on a separate connection. Combined, these attributes of changefeeds mean that applications should explicitly create dedicated connections to consume changefeed data, instead of using a connection pool as most client drivers do by default. | ||
Because core changefeeds return results differently than other SQL statements, they require a dedicated database connection with specific settings around result buffering. In normal operation, CockroachDB improves performance by buffering results server-side before returning them to a client; however, result buffering is automatically turned off for core changefeeds. Core changefeeds also have different cancellation behavior than other queries: they can only be canceled by closing the underlying connection or issuing a [`CANCEL QUERY`](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/cancel-query) statement on a separate connection. Combined, these attributes of changefeeds mean that applications should explicitly create dedicated connections to consume changefeed data, instead of using a connection pool as most client drivers do by default. | ||
{{site.data.alerts.end}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.