Skip to content

Commit

Permalink
Resolve more non-301 redirects
Browse files Browse the repository at this point in the history
  • Loading branch information
Jesse Seldess committed May 31, 2021
1 parent a179ba2 commit 5b3ea00
Show file tree
Hide file tree
Showing 260 changed files with 220 additions and 425 deletions.
17 changes: 0 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,6 @@ Field | Description | Default
`asciicast` | Adds code required to play asciicasts on the page. See [Asciicasts](#asciicasts) for more details. | `false`
`feedback` | Adds "Yes/No" feedback buttons at the bottom of the page. See [Feedback Widget](#feedback-widget) for more details. | `true`
`contribute` | Adds "Contribute" options at the top-right of the page. See [Contributing Options](#contributing-options) for more details. | `true`
`redirect_from` | Specifies other internal URLs that should redirect to the page. See [Client-Side Redirects](#client-side-redirects) | Nothing
`twitter` | Adds code required to track the page as part of a Twitter campaign | `false`
`no_sidebar` | If `true`, removes the sidebar from a page. See [Sidebar](#sidebar) for more details. | Nothing
`block_search` | If `true`, adds meta tags to the header that excludes the page from search indexing/caching. | Nothing
Expand Down Expand Up @@ -241,22 +240,6 @@ We show "Yes/No" feedback buttons at the bottom of every page by default. To rem
We show "Contribute" options in the top-right of every page by default. To remove these options from a page, set `contribute: false` in the page's front-matter.
#### Client-Side Redirects
We use the [JekyllRedirectFrom](https://github.com/jekyll/jekyll-redirect-from) plugin to ensure that multiple URLs resolve to a single page. This is most useful in cases where we change the filename or directory structure of a page.
For example, if `v1.0.html` page were moved from the root level to `releases/v1.0.html`, you would add `redirect-from: /v1.0.html` to the page's front-matter to ensure that `https://cockroachlabs.com/docs/v1.0.html` gets redirected to `https:/cockroachlabs.com/docs/releases/v1.0.html`.
If you rename or restructure a versioned page, use a relative link, not an absolute link. For example, if `show-transaction.md` and `show-time-zone.md` are merged into `show-vars.md` for v1.1, use the following `redirect_from` specification:
```md
redirect_from:
- show-transaction.html
- show-time-zone.html
```

This ensures that if `v1.1` is also the `stable` or `dev` version, the corresponding `stable` or `dev` redirects will be generated as well.

### Sidebar
For each documented version of CockroachDB, a JSON file in the `_includes` directory defines the pages that appear in the docs sidebar. For example, the sidebar for CockroachDB v1.0 is defined by [`_includes/sidebar-data-v1.0.json`](https://github.com/cockroachdb/docs/blob/master/_includes/sidebar-data-v1.0.json).
Expand Down
4 changes: 2 additions & 2 deletions _includes/sidebar-data-v1.0.json
Original file line number Diff line number Diff line change
Expand Up @@ -954,9 +954,9 @@
]
},
{
"title": "General Troubleshooting",
"title": "Common Errors",
"urls": [
"/${VERSION}/general-troubleshooting.html"
"/${VERSION}/common-errors.html"
]
},
{
Expand Down
3 changes: 1 addition & 2 deletions _includes/sidebar-data-v20.2.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@
"/${VERSION}/install-cockroachdb.html",
"/${VERSION}/install-cockroachdb-mac.html",
"/${VERSION}/install-cockroachdb-linux.html",
"/${VERSION}/install-cockroachdb-windows.html",
"/${VERSION}/install-cockroachdb-spatial.html"
"/${VERSION}/install-cockroachdb-windows.html"
]
},
{
Expand Down
3 changes: 1 addition & 2 deletions _includes/sidebar-data-v21.1.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@
"/${VERSION}/install-cockroachdb.html",
"/${VERSION}/install-cockroachdb-mac.html",
"/${VERSION}/install-cockroachdb-linux.html",
"/${VERSION}/install-cockroachdb-windows.html",
"/${VERSION}/install-cockroachdb-spatial.html"
"/${VERSION}/install-cockroachdb-windows.html"
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions _includes/v19.2/app/see-also-links.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
You might also be interested in the following pages:

- [Client Connection Parameters](connection-parameters.html)
- [Data Replication](demo-data-replication.html)
- [Data Replication](demo-replication-and-rebalancing.html)
- [Fault Tolerance & Recovery](demo-fault-tolerance-and-recovery.html)
- [Automatic Rebalancing](demo-automatic-rebalancing.html)
- [Replication & Rebalancing](demo-replication-and-rebalancing.html)
- [Cross-Cloud Migration](demo-automatic-cloud-migration.html)
- [Follow-the-Workload](demo-follow-the-workload.html)
- [Automated Operations](orchestrate-a-local-cluster-with-kubernetes-insecure.html)
2 changes: 1 addition & 1 deletion _includes/v19.2/misc/install-next-steps.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<li><a href="start-a-local-cluster.html">Start a cluster locally</a> and talk to it via the built-in SQL client</li>
<li><a href="learn-cockroachdb-sql.html">Learn more about CockroachDB SQL</a></li>
<li><a href="hello-world-example-apps.html">Build a simple application</a> with CockroachDB using Postgres-compatible client drivers and ORMs</li>
<li><a href="demo-data-replication.html">Explore core CockroachDB features</a> like automatic replication, rebalancing, and fault tolerance</li>
<li><a href="demo-replication-and-rebalancing.html">Explore core CockroachDB features</a> like automatic replication, rebalancing, and fault tolerance</li>
</ul>
</li>
<li>If you&#39;re ready to run CockroachDB in production:
Expand Down
2 changes: 1 addition & 1 deletion _includes/v19.2/start-in-docker/mac-linux-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ The CockroachDB [Admin UI](admin-ui-overview.html) gives you insight into the ov
<img src="{{ 'images/v19.2/admin_ui_cluster_overview_3_nodes.png' | relative_url }}" alt="CockroachDB Admin UI" style="border:1px solid #eee;max-width:100%" />
This demonstrates CockroachDB's [automated replication](demo-data-replication.html) of data via the Raft consensus protocol.
This demonstrates CockroachDB's [automated replication](demo-replication-and-rebalancing.html) of data via the Raft consensus protocol.

{{site.data.alerts.callout_info}}
Capacity metrics can be incorrect when running multiple nodes on a single machine. For more details, see this [limitation](known-limitations.html#available-capacity-metric-in-the-admin-ui).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,5 +59,5 @@ To view the zone configuration for a partition, use `SHOW ZONE CONFIGURATION FOR
~~~

{{site.data.alerts.callout_success}}
<span class="version-tag">New in v19.2:</span> You can also use the [`SHOW CREATE TABLE`](show-create-table.html) statement or [`SHOW PARTITIONS`](show-partitions.html) statements to view details about all of the replication zones defined for the partitions of a table and its secondary indexes.
<span class="version-tag">New in v19.2:</span> You can also use the [`SHOW CREATE TABLE`](show-create.html) statement or [`SHOW PARTITIONS`](show-partitions.html) statements to view details about all of the replication zones defined for the partitions of a table and its secondary indexes.
{{site.data.alerts.end}}
4 changes: 2 additions & 2 deletions _includes/v20.1/app/see-also-links.md
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](connection-parameters.html)
- [Data Replication](demo-data-replication.html)
- [Data Replication](demo-replication-and-rebalancing.html)
- [Fault Tolerance & Recovery](demo-fault-tolerance-and-recovery.html)
- [Automatic Rebalancing](demo-automatic-rebalancing.html)
- [Replication & Rebalancing](demo-replication-and-rebalancing.html)
- [Cross-Cloud Migration](demo-automatic-cloud-migration.html)
- [Automated Operations](orchestrate-a-local-cluster-with-kubernetes-insecure.html)
2 changes: 1 addition & 1 deletion _includes/v20.1/misc/install-next-steps.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<li><a href="start-a-local-cluster.html">Start a cluster locally</a> and talk to it via the built-in SQL client</li>
<li><a href="learn-cockroachdb-sql.html">Learn more about CockroachDB SQL</a></li>
<li><a href="hello-world-example-apps.html">Build a simple application</a> with CockroachDB using Postgres-compatible client drivers and ORMs</li>
<li><a href="demo-data-replication.html">Explore core CockroachDB features</a> like automatic replication, rebalancing, and fault tolerance</li>
<li><a href="demo-replication-and-rebalancing.html">Explore core CockroachDB features</a> like automatic replication, rebalancing, and fault tolerance</li>
</ul>
</li>
<li>If you&#39;re ready to run CockroachDB in production:
Expand Down
2 changes: 1 addition & 1 deletion _includes/v20.1/start-in-docker/mac-linux-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ The CockroachDB [Admin UI](admin-ui-overview.html) gives you insight into the ov
<img src="{{ 'images/v20.1/admin_ui_cluster_overview_3_nodes.png' | relative_url }}" alt="CockroachDB Admin UI" style="border:1px solid #eee;max-width:100%" />
This demonstrates CockroachDB's [automated replication](demo-data-replication.html) of data via the Raft consensus protocol.
This demonstrates CockroachDB's [automated replication](demo-replication-and-rebalancing.html) of data via the Raft consensus protocol.

{{site.data.alerts.callout_info}}
Capacity metrics can be incorrect when running multiple nodes on a single machine. For more details, see this [limitation](known-limitations.html#available-capacity-metric-in-the-admin-ui).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,5 @@ To view the zone configuration for a partition, use `SHOW ZONE CONFIGURATION FOR
~~~

{{site.data.alerts.callout_success}}
You can also use the [`SHOW CREATE TABLE`](show-create-table.html) statement or [`SHOW PARTITIONS`](show-partitions.html) statements to view details about all of the replication zones defined for the partitions of a table and its secondary indexes.
You can also use the [`SHOW CREATE TABLE`](show-create.html) statement or [`SHOW PARTITIONS`](show-partitions.html) statements to view details about all of the replication zones defined for the partitions of a table and its secondary indexes.
{{site.data.alerts.end}}
4 changes: 2 additions & 2 deletions _includes/v20.2/app/see-also-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ You might also be interested in the following pages:

- [Client Connection Parameters](connection-parameters.html)
- [Connection Pooling](connection-pooling.html)
- [Data Replication](demo-data-replication.html)
- [Data Replication](demo-replication-and-rebalancing.html)
- [Fault Tolerance & Recovery](demo-fault-tolerance-and-recovery.html)
- [Automatic Rebalancing](demo-automatic-rebalancing.html)
- [Replication & Rebalancing](demo-replication-and-rebalancing.html)
- [Cross-Cloud Migration](demo-automatic-cloud-migration.html)
- [Automated Operations](orchestrate-a-local-cluster-with-kubernetes-insecure.html)
2 changes: 1 addition & 1 deletion _includes/v20.2/misc/install-next-steps.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<li><a href="start-a-local-cluster.html">Start a cluster locally</a> and talk to it via the built-in SQL client</li>
<li><a href="learn-cockroachdb-sql.html">Learn more about CockroachDB SQL</a></li>
<li><a href="hello-world-example-apps.html">Build a simple application</a> with CockroachDB using Postgres-compatible client drivers and ORMs</li>
<li><a href="demo-data-replication.html">Explore core CockroachDB features</a> like automatic replication, rebalancing, and fault tolerance</li>
<li><a href="demo-replication-and-rebalancing.html">Explore core CockroachDB features</a> like automatic replication, rebalancing, and fault tolerance</li>
</ul>
</li>
<li>If you&#39;re ready to run CockroachDB in production:
Expand Down
2 changes: 1 addition & 1 deletion _includes/v20.2/start-in-docker/mac-linux-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ The CockroachDB [DB Console](ui-overview.html) gives you insight into the overal
<img src="{{ 'images/v20.2/ui_cluster_overview_3_nodes.png' | relative_url }}" alt="DB Console" style="border:1px solid #eee;max-width:100%" />
This demonstrates CockroachDB's [automated replication](demo-data-replication.html) of data via the Raft consensus protocol.
This demonstrates CockroachDB's [automated replication](demo-replication-and-rebalancing.html) of data via the Raft consensus protocol.

{{site.data.alerts.callout_info}}
Capacity metrics can be incorrect when running multiple nodes on a single machine. For more details, see this [limitation](known-limitations.html#available-capacity-metric-in-the-db-console).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,5 @@ To view the zone configuration for a partition, use `SHOW ZONE CONFIGURATION FOR
~~~

{{site.data.alerts.callout_success}}
You can also use the [`SHOW CREATE TABLE`](show-create-table.html) statement or [`SHOW PARTITIONS`](show-partitions.html) statements to view details about all of the replication zones defined for the partitions of a table and its secondary indexes.
You can also use the [`SHOW CREATE TABLE`](show-create.html) statement or [`SHOW PARTITIONS`](show-partitions.html) statements to view details about all of the replication zones defined for the partitions of a table and its secondary indexes.
{{site.data.alerts.end}}
4 changes: 2 additions & 2 deletions _includes/v21.1/app/see-also-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ You might also be interested in the following pages:

- [Client Connection Parameters](connection-parameters.html)
- [Connection Pooling](connection-pooling.html)
- [Data Replication](demo-data-replication.html)
- [Data Replication](demo-replication-and-rebalancing.html)
- [Fault Tolerance & Recovery](demo-fault-tolerance-and-recovery.html)
- [Automatic Rebalancing](demo-automatic-rebalancing.html)
- [Replication & Rebalancing](demo-replication-and-rebalancing.html)
- [Cross-Cloud Migration](demo-automatic-cloud-migration.html)
- [Automated Operations](orchestrate-a-local-cluster-with-kubernetes-insecure.html)
2 changes: 1 addition & 1 deletion _includes/v21.1/misc/install-next-steps.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<li><a href="start-a-local-cluster.html">Start a cluster locally</a> and talk to it via the built-in SQL client</li>
<li><a href="learn-cockroachdb-sql.html">Learn more about CockroachDB SQL</a></li>
<li><a href="hello-world-example-apps.html">Build a simple application</a> with CockroachDB using Postgres-compatible client drivers and ORMs</li>
<li><a href="demo-data-replication.html">Explore core CockroachDB features</a> like automatic replication, rebalancing, and fault tolerance</li>
<li><a href="demo-replication-and-rebalancing.html">Explore core CockroachDB features</a> like automatic replication, rebalancing, and fault tolerance</li>
</ul>
</li>
<li>If you&#39;re ready to run CockroachDB in production:
Expand Down
2 changes: 1 addition & 1 deletion _includes/v21.1/start-in-docker/mac-linux-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ The CockroachDB [DB Console](ui-overview.html) gives you insight into the overal
<img src="{{ 'images/v21.1/ui_cluster_overview_3_nodes.png' | relative_url }}" alt="DB Console" style="border:1px solid #eee;max-width:100%" />
This demonstrates CockroachDB's [automated replication](demo-data-replication.html) of data via the Raft consensus protocol.
This demonstrates CockroachDB's [automated replication](demo-replication-and-rebalancing.html) of data via the Raft consensus protocol.

{{site.data.alerts.callout_info}}
Capacity metrics can be incorrect when running multiple nodes on a single machine. For more details, see this [limitation](known-limitations.html#available-capacity-metric-in-the-db-console).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,5 @@ To view the zone configuration for a partition, use `SHOW ZONE CONFIGURATION FRO
~~~

{{site.data.alerts.callout_success}}
You can also use the [`SHOW CREATE TABLE`](show-create-table.html) statement or [`SHOW PARTITIONS`](show-partitions.html) statements to view details about all of the replication zones defined for the partitions of a table and its secondary indexes.
You can also use the [`SHOW CREATE TABLE`](show-create.html) statement or [`SHOW PARTITIONS`](show-partitions.html) statements to view details about all of the replication zones defined for the partitions of a table and its secondary indexes.
{{site.data.alerts.end}}
Loading

0 comments on commit 5b3ea00

Please sign in to comment.