DOC-17063: Replace source file/directory links#23299
Merged
Merged
Conversation
|
✅ Cross-Version Link Check Passed All cross-version link issues have been resolved. Good job! |
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
4 tasks
Unlink 111 pages that reference github.com/cockroachdb/cockroach/blob or /tree paths. These links pointed to cockroach source code files and directories that are not useful for docs readers. Part of DOC-17063. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
ebembi-crdb
force-pushed
the
unlink-source-file-links
branch
from
2d400cb to
75888f9
Compare
Replace hardcoded images/v24.2/raw-status-endpoints.png with
images/{{ page.version.version }}/raw-status-endpoints.png in
monitoring-and-alerting.md for v25.1, v25.2, and v25.3.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Use absolute /docs/images/ path with {{ page.version.version }} instead
of nesting {{ }} inside {{ }} (which Liquid can't evaluate).
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
rmloveland
reviewed
May 21, 2026
rmloveland
requested changes
May 26, 2026
| - [Cluster API]({% link {{ page.version.version }}/cluster-api.md %}) | ||
| - [Essential Alerts]({% link {{ page.version.version }}/essential-alerts-{{ include.deployment}}.md %}) | ||
| - [CockroachDB Source Code - DB Console metrics to graphs mappings (in *.tsx files)](https://github.com/cockroachdb/cockroach/tree/master/pkg/ui/workspaces/db-console/src/views/cluster/containers/nodeGraphs/dashboards) | ||
| - CockroachDB Source Code - DB Console metrics to graphs mappings (in *.tsx files) |
Contributor
There was a problem hiding this comment.
let's remove this line entirely, in this and all other versions of this file
| However, for non-indexed columns (e.g., non-`PRIMARY KEY` columns), CockroachDB instead uses an encoding (known as "value encoding") which consumes less space but does not preserve ordering. | ||
|
|
||
| You can find more exhaustive detail in the [Encoding Tech Note](https://github.com/cockroachdb/cockroach/blob/master/docs/tech-notes/encoding.md). | ||
| You can find more exhaustive detail in [the Encoding Tech Note](https://github.com/cockroachdb/docs/blob/main/src/current/files/cockroach/docs/tech-notes/encoding.md). |
Contributor
There was a problem hiding this comment.
please remove this line entirely, we're no longer going to be referring to tech-notes or RFCs from the cockroach repo at all
| ## See also | ||
|
|
||
| The [technical note for admission control](https://github.com/cockroachdb/cockroach/blob/master/docs/tech-notes/admission_control.md) for details on the design of the admission control system. | ||
| The [technical note for admission control](https://github.com/cockroachdb/docs/blob/main/src/current/files/cockroach/docs/tech-notes/admission_control.md) for details on the design of the admission control system. |
Contributor
There was a problem hiding this comment.
please remove this bullet entirely (here and in all other versions), we're no longer going to be referring to tech-notes/RFCs from the cockroach repo
|
|
||
| If you do not want to use the FIPS-ready CockroachDB Docker image directly, you can create a custom Docker image based on [Red Hat's Universal Base Image 8 Docker image](https://catalog.redhat.com/software/containers/ubi8/ubi/): | ||
|
|
||
| - You can model your Dockerfile on the one that Cockroach Labs uses to produce the [FIPS-ready Docker image](https://github.com/cockroachdb/cockroach/blob/master/build/deploy/Dockerfile) for CockroachDB. |
Contributor
There was a problem hiding this comment.
update 2026-05-26: let's just remove this bullet, we don't have the expertise to vendor this file and maintain it in docs unless/until we commit to that as a team. For now, let's remove this bullet
| A number of independent factors affect performance when running CockroachDB on Kubernetes. Most are easiest to change before you create your CockroachDB cluster. If you need to modify a CockroachDB cluster that is already running on Kubernetes, extra care and testing is strongly recommended. | ||
|
|
||
| The following sections show how to modify excerpts from our provided Kubernetes configuration YAML files. You can find the most up-to-date versions of these files on GitHub: [one for running CockroachDB in secure mode](https://github.com/cockroachdb/cockroach/blob/master/cloud/kubernetes/cockroachdb-statefulset-secure.yaml) and one for [running CockroachDB in insecure mode](https://github.com/cockroachdb/cockroach/blob/master/cloud/kubernetes/cockroachdb-statefulset.yaml). | ||
| The following sections show how to modify excerpts from our provided Kubernetes configuration YAML files. You can find the most up-to-date versions of these files on GitHub: [one for running CockroachDB in secure mode](https://github.com/cockroachdb/docs/blob/main/src/current/files/cockroach/cloud/kubernetes/cockroachdb-statefulset-secure.yaml) and one for [running CockroachDB in insecure mode](https://github.com/cockroachdb/docs/blob/main/src/current/files/cockroach/cloud/kubernetes/cockroachdb-statefulset.yaml). |
Contributor
There was a problem hiding this comment.
i think we're vendoring stuff in #23298 in a similar way - per my comments on that PR, please change these links - nothing should ever refer to github repos or github.com or githubusercontent.com - all links to local files should use the {% link ... %} syntax we use for links in Jekyll
|
|
||
| - The [Overload Dashboard]({% link {{ page.version.version }}/ui-overload-dashboard.md %}) in the [DB Console]({% link {{ page.version.version }}/ui-overview.md %}). | ||
| - The [technical note for admission control](https://github.com/cockroachdb/cockroach/blob/master/docs/tech-notes/admission_control.md) for details on the design of the admission control system. | ||
| - The technical note for admission control for details on the design of the admission control system. |
Contributor
There was a problem hiding this comment.
please remove this line altogether
| However, for non-indexed columns (e.g., non-`PRIMARY KEY` columns), CockroachDB instead uses an encoding (known as "value encoding") which consumes less space but does not preserve ordering. | ||
|
|
||
| You can find more exhaustive detail in the [Encoding Tech Note](https://github.com/cockroachdb/cockroach/blob/master/docs/tech-notes/encoding.md). | ||
| You can find more exhaustive detail in [the Encoding Tech Note](https://github.com/cockroachdb/docs/blob/main/src/current/files/cockroach/docs/tech-notes/encoding.md). |
Contributor
There was a problem hiding this comment.
please remove this line altogether
| If you do not want to use the FIPS-ready CockroachDB Docker image directly, you can create a custom Docker image based on [Red Hat's Universal Base Image 8 Docker image](https://catalog.redhat.com/software/containers/ubi8/ubi/): | ||
|
|
||
| - You can model your Dockerfile on the one that Cockroach Labs uses to produce the [FIPS-ready Docker image](https://github.com/cockroachdb/cockroach/blob/master/build/deploy/Dockerfile) for CockroachDB. | ||
| - You can model your Dockerfile on the one that Cockroach Labs uses to produce the FIPS-ready Docker image for CockroachDB. |
Contributor
There was a problem hiding this comment.
please remove this line altogether
| If you do not want to use the FIPS-ready CockroachDB Docker image directly, you can create a custom Docker image based on [Red Hat's Universal Base Image 8 Docker image](https://catalog.redhat.com/software/containers/ubi8/ubi/): | ||
|
|
||
| - You can model your Dockerfile on the one that Cockroach Labs uses to produce the [FIPS-ready Docker image](https://github.com/cockroachdb/cockroach/blob/master/build/deploy/Dockerfile) for CockroachDB. | ||
| - You can model your Dockerfile on the one that Cockroach Labs uses to produce the FIPS-ready Docker image for CockroachDB. |
Contributor
There was a problem hiding this comment.
please remove this line here and in all other versions of this file
| Several endpoints return raw status meta information in JSON at `http://<host>:<http-port>/#/debug`. You can investigate and use these endpoints, but note that they are subject to change. | ||
|
|
||
| <img src="{{ 'images/v24.2/raw-status-endpoints.png' | relative_url }}" alt="Raw Status Endpoints" style="border:1px solid #eee;max-width:100%" /> | ||
| <img src="/docs/images/{{ page.version.version }}/raw-status-endpoints.png" alt="Raw Status Endpoints" style="border:1px solid #eee;max-width:100%" /> |
Contributor
There was a problem hiding this comment.
this will probably fail to build, i think these image paths need to be hardcoded (v25.1 in this case)
rmloveland
requested changes
May 26, 2026
Contributor
rmloveland
left a comment
rmloveland
left a comment
There was a problem hiding this comment.
@ebembi-crdb needs a few fixes but overall direction similar to #23298 of vendoring files seems good
PS once you've addressed my comments in the existing versions please also port the changes forward to v26.3 docs (need to rebase), since #23371 beat us in
# Conflicts: # src/current/v25.2/monitoring-and-alerting.md
Per reviewer comments:
- Remove FIPS Dockerfile bullet from fips.md (all versions)
- Remove CockroachDB Source Code line from essential-metrics.md
- Remove Encoding Tech Note and DistSQL RFC references from sql-layer.md
- Remove Admission Control tech note references from admission-control.md
- Remove RFC links from restore.md (keep text, unlink)
- Remove "Tracking GitHub Issue" text from restore.md
- Replace GitHub links with {% link %} for vendored K8s config files
in kubernetes-performance.md
- Fix image paths in monitoring-and-alerting.md (hardcode version)
- Replace GitHub links with {% link %} for alerts.rules.yml in
monitoring-and-alerting.md
- Replace GitHub links with {% link %} in schedule-cockroachdb-*.md
- Remove Read Committed RFC references from read-committed.md
- Vendor K8s config files and alerts.rules.yml for {% link %} usage
- Apply all changes to v26.3
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
rmloveland
approved these changes
May 27, 2026
Contributor
rmloveland
left a comment
rmloveland
left a comment
There was a problem hiding this comment.
LGTM thanks @ebembi-crdb - please merge at will!
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
github.com/cockroachdb/cockroach/blobor/treepathsThis is PR 9 of 10 splitting #23256 into reviewable chunks.
Jira: DOC-17063
Test plan
github.com/cockroachdb/cockroach/blobor/treelinks in affected files🤖 Generated with Claude Code