DOC-17057: Remove inline cockroach issue/PR links from docs prose#23306
Open
ebembi-crdb wants to merge 9 commits into
Open
DOC-17057: Remove inline cockroach issue/PR links from docs prose#23306ebembi-crdb wants to merge 9 commits into
ebembi-crdb wants to merge 9 commits into
Conversation
Unlink 292 docs pages by removing markdown hyperlinks to cockroach issues and PRs, keeping the #NNNNN reference text. This is the catch-all for link-only changes not covered by the more specific release notes, known limitations, advisories, or other targeted PRs. Part of DOC-17057. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
|
✅ Cross-Version Link Check Passed All cross-version link issues have been resolved. Good job! |
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
Files changed:
|
4 tasks
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
- Replace hardcoded ../v23.1/*.html relative links with
{% link {{ page.version.version }}/... %} tags in
_includes/v{23.2-25.3}/backward-incompatible/alpha.1.md
(matching the pattern already used in v24.3)
- Replace hardcoded images/v24.2/geospatial/st_union.png with
images/{{ page.version.version }}/geospatial/st_union.png
in st_union.md for v25.1 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
requested changes
May 21, 2026
Contributor
rmloveland
left a comment
rmloveland
left a comment
There was a problem hiding this comment.
needs a fair amount of work, please see my comments
in general, removing link targets is not sufficient. in most cases, we need to remove the entire sentences of the form "Tracking github issue", "for more information, see #xxx", etc.
| @@ -1 +1 @@ | |||
| [`ROLLBACK TO SAVEPOINT`](rollback-transaction.html#rollback-a-nested-transaction) (for either regular savepoints or "restart savepoints" defined with `cockroach_restart`) causes a "feature not supported" error after a DDL statement in a [`HIGH PRIORITY` transaction](transactions.html#transaction-priorities), in order to avoid a transaction deadlock. For more information, see GitHub issue [#46414](https://www.github.com/cockroachdb/cockroach/issues/46414). | |||
| [`ROLLBACK TO SAVEPOINT`](rollback-transaction.html#rollback-a-nested-transaction) (for either regular savepoints or "restart savepoints" defined with `cockroach_restart`) causes a "feature not supported" error after a DDL statement in a [`HIGH PRIORITY` transaction](transactions.html#transaction-priorities), in order to avoid a transaction deadlock. For more information, see GitHub issue #46414. | |||
Contributor
There was a problem hiding this comment.
removing the link target is not sufficient - please remove the entire "for more information, see github issue #xxx "
| @@ -1 +1 @@ | |||
| A changefeed in [Avro format]({% link {{ page.version.version }}/changefeed-messages.md %}#avro) will not be able to serialize [user-defined composite (tuple) types](create-type.html). [Tracking GitHub Issue](https://github.com/cockroachdb/cockroach/issues/102903) No newline at end of file | |||
| A changefeed in [Avro format]({% link {{ page.version.version }}/changefeed-messages.md %}#avro) will not be able to serialize [user-defined composite (tuple) types](create-type.html). Tracking GitHub Issue No newline at end of file | |||
Contributor
There was a problem hiding this comment.
removing the link target is not sufficient. please remove this and all other instances of "Tracking Github issue"
| CockroachDB is a [distributed SQL](https://www.cockroachlabs.com/blog/what-is-distributed-sql/) database built on a transactional and strongly-consistent key-value store. It **scales** horizontally; **survives** disk, machine, rack, and even datacenter failures with minimal latency disruption and no manual intervention; supports **strongly-consistent** ACID transactions; and provides a familiar **SQL** API for structuring, manipulating, and querying data. | ||
|
|
||
| CockroachDB is inspired by Google's [Spanner](http://research.google.com/archive/spanner.html) and [F1](http://research.google.com/pubs/pub38125.html) technologies, and the [source code](https://github.com/cockroachdb/cockroach) is freely available. | ||
| CockroachDB is inspired by Google's [Spanner](http://research.google.com/archive/spanner.html) and [F1](http://research.google.com/pubs/pub38125.html) technologies, and the source code is freely available. |
Contributor
There was a problem hiding this comment.
please remove ", and the source code is freely available" - here and in all other versions where it appears in this file
|
|
||
| {{site.data.alerts.callout_info}} | ||
| The amount of remaining disk space on other nodes in the cluster is not yet considered as part of the decommissioning pre-flight checks. For more information, see [cockroachdb/cockroach#71757](https://github.com/cockroachdb/cockroach/issues/71757) | ||
| The amount of remaining disk space on other nodes in the cluster is not yet considered as part of the decommissioning pre-flight checks. For more information, see cockroachdb/cockroach#71757 |
Contributor
There was a problem hiding this comment.
please remove the "For more information, see" sentence entirely
| @@ -1 +1 @@ | |||
| [`ROLLBACK TO SAVEPOINT`]({% link {{ page.version.version }}/rollback-transaction.md %}#rollback-a-nested-transaction) (for either regular savepoints or "restart savepoints" defined with `cockroach_restart`) causes a "feature not supported" error after a DDL statement in a [`HIGH PRIORITY` transaction]({% link {{ page.version.version }}/transactions.md %}#transaction-priorities), in order to avoid a transaction deadlock. For more information, see GitHub issue [#46414](https://www.github.com/cockroachdb/cockroach/issues/46414). | |||
| [`ROLLBACK TO SAVEPOINT`]({% link {{ page.version.version }}/rollback-transaction.md %}#rollback-a-nested-transaction) (for either regular savepoints or "restart savepoints" defined with `cockroach_restart`) causes a "feature not supported" error after a DDL statement in a [`HIGH PRIORITY` transaction]({% link {{ page.version.version }}/transactions.md %}#transaction-priorities), in order to avoid a transaction deadlock. For more information, see GitHub issue #46414. | |||
Contributor
There was a problem hiding this comment.
removing the link target is not sufficient. please remove "for more information, see github issue #xxx " - here and elsewhere
| If you have corrupted data in a database or table, [restore]({% link {{ page.version.version }}/restore.md %}) the object from a prior [backup]({% link {{ page.version.version }}/backup.md %}). If revision history is in the backup, you can restore from a [point in time]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}). | ||
|
|
||
| Instead of dropping the corrupted table or database, we recommend [renaming the table]({% link {{ page.version.version }}/alter-table.md %}#rename-to) or [renaming the database]({% link {{ page.version.version }}/alter-database.md %}#rename-to) so you have historical data to compare to later. If you drop a database, the database cannot be referenced with `AS OF SYSTEM TIME` queries (see [#51380](https://github.com/cockroachdb/cockroach/issues/51380) for more information), and you will need to take a backup that is backdated to the system time when the database still existed. | ||
| Instead of dropping the corrupted table or database, we recommend [renaming the table]({% link {{ page.version.version }}/alter-table.md %}#rename-to) or [renaming the database]({% link {{ page.version.version }}/alter-database.md %}#rename-to) so you have historical data to compare to later. If you drop a database, the database cannot be referenced with `AS OF SYSTEM TIME` queries (see #51380 for more information), and you will need to take a backup that is backdated to the system time when the database still existed. |
Contributor
There was a problem hiding this comment.
please remove the parenthetical "(see #XXX for more info)" here and in all other versions
|
|
||
| 1. You haven't created any indexes at all yet. The query is likely to be doing full table scans, which you will need to hunt down with [`EXPLAIN`]({% link {{ page.version.version }}/explain.md %}). | ||
| 1. CockroachDB does not yet have built-in support for index-based nearest neighbor queries. If this feature is important to you, please comment with some information about your use case on [cockroachdb/cockroach#55227](https://github.com/cockroachdb/cockroach/issues/55227). | ||
| 1. CockroachDB does not yet have built-in support for index-based nearest neighbor queries. If this feature is important to you, please comment with some information about your use case on cockroachdb/cockroach#55227. |
Contributor
There was a problem hiding this comment.
please remove the sentence "if this feature is important to you, ..." on this and all other versions of this page
|
|
||
| {{site.data.alerts.callout_info}} | ||
| {% include feature-phases/preview.md %} For details, see the tracking issue [cockroachdb/cockroach#46260](https://github.com/cockroachdb/cockroach/issues/46260). | ||
| {% include feature-phases/preview.md %} For details, see the tracking issue cockroachdb/cockroach#46260. |
Contributor
There was a problem hiding this comment.
please remove "for details ..." here and elsewhere
| ### Check for constraint violations with `SCRUB` | ||
|
|
||
| Checks the consistency of [`UNIQUE`]({% link {{ page.version.version }}/unique.md %}) indexes, [`CHECK`]({% link {{ page.version.version }}/check.md %}) constraints, and more. Partially implemented; see [cockroachdb/cockroach#10425](https://github.com/cockroachdb/cockroach/issues/10425) for details. | ||
| Checks the consistency of [`UNIQUE`]({% link {{ page.version.version }}/unique.md %}) indexes, [`CHECK`]({% link {{ page.version.version }}/check.md %}) constraints, and more. Partially implemented; see cockroachdb/cockroach#10425 for details. |
Contributor
There was a problem hiding this comment.
please remove everything after the semicolon after "Partially implemented; ..." here and in all other versions of this page
| The following diagram presents the same set of schema objects as the previous outline-style diagram, but using boxes and lines joined with arrows that represent the "top-down" view. | ||
|
|
||
| Each box represents a schema object in the zone configuration inheritance hierarchy. Each solid line ends in an arrow that points from a parent object to its child object, which will inherit the parent's values unless those values are changed at the child level. The dotted lines between partitions and sub-partitions represent the known limitation mentioned previously that sub-partitions do not inherit their values from their parent partitions. Instead, sub-partitions inherit their values from the parent table. For more information about this limitation, see [cockroachdb/cockroach#75862](https://github.com/cockroachdb/cockroach/issues/75862). | ||
| Each box represents a schema object in the zone configuration inheritance hierarchy. Each solid line ends in an arrow that points from a parent object to its child object, which will inherit the parent's values unless those values are changed at the child level. The dotted lines between partitions and sub-partitions represent the known limitation mentioned previously that sub-partitions do not inherit their values from their parent partitions. Instead, sub-partitions inherit their values from the parent table. For more information about this limitation, see cockroachdb/cockroach#75862. |
Contributor
There was a problem hiding this comment.
please remove "for more about this limitation, see ..." here and on all other versions of this page
Address all 27 review comments: removing link targets alone was not sufficient. Removes entire sentences/phrases that only existed to reference GitHub issues/PRs, across all version directories: - Remove "For more information, see #xxx" sentences (decommission pre-flight checks, trigram indexes, temporary tables, configure replication zones, foreign keys, savepoints) - Remove "Tracking GitHub Issue" / bare issue IDs (CDC avro/csv composites, select-for-update limitations) - Remove "see tracking issue" text (partial indexes, CTEs) - Remove "GitHub issue tracking FOO support" entries (sql-feature-support) - Remove ", and the source code is freely available" (what-is-crdb FAQ) - Remove "if this feature is important to you, ..." (spatial-tutorial) - Remove "Partially implemented; see #xxx" → "Partially implemented." (cockroachdb-feature-availability) - Remove "(see #xxx for more info)" parentheticals (disaster-recovery) - Replace GitHub meta-issue reference with Contact Support CTA (query-spatial-data) - Remove meaningless unlinked tracking text (full-text-search) 157 files changed across 13 patterns. Addresses review feedback from @rmloveland. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Removes ~280 tracking issue references across 127 files: - [Tracking GitHub issue](url) from known-limitations.md, UDF, CDC, copy-syntax, and other _includes files - [GitHub tracking issue](url) standalone links (8 known-limitations) - Bare "Tracking GitHub Issue" text (alter-changefeed, jsonb) - "See tracking issue" / "For details, see tracking issue" from views.md, create-sequence.md, sql-name-resolution.md - "Tracking issue: cockroachdb/cockroach#XXXXX" from unsupported-postgres-features.md (7 versions) - "Refer to GitHub tracking issue" from install-cockroachdb-mac.md - Tracking issues cross-ref from restore.md (11 versions) - "[GitHub tracking issue](url) for details" from unordered-operations.md Preserves advisory page references and backward-incompatible/alpha files per reviewer guidance. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
ebembi-crdb
force-pushed
the
unlink-docs-prose
branch
from
735cbd2 to
c065c04
Compare
The cleanup script accidentally appended a period to closing code fences (~~~. instead of ~~~), leaving them unclosed. This caused all subsequent headings to be swallowed into code blocks, breaking the #spatial-support-limitations and #create-a-table-with-a-jsonb-column anchors. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Resolve conflicts in postgresql-compatibility.md for v23.1 and v23.2: keep blank lines before headings that were added on main. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
rmloveland
requested changes
May 26, 2026
| Note the following limitations of identity columns: | ||
|
|
||
| - `GENERATED ALWAYS AS IDENTITY`/`GENERATED BY DEFAULT AS IDENTITY` is supported in [`ALTER TABLE ... ADD COLUMN`]({% link {{ page.version.version }}/alter-table.md %}#add-column) statements only when the table being altered is empty, as [CockroachDB does not support back-filling sequential column data]({% link {{ page.version.version }}/known-limitations.md %}#adding-a-column-with-sequence-based-default-values). For more information, see the [Tracking GitHub Issue](https://github.com/cockroachdb/cockroach/issues/42508). | ||
| - `GENERATED ALWAYS AS IDENTITY`/`GENERATED BY DEFAULT AS IDENTITY` is supported in [`ALTER TABLE ... ADD COLUMN`]({% link {{ page.version.version }}/alter-table.md %}#add-column) statements only when the table being altered is empty, as [CockroachDB does not support back-filling sequential column data]({% link {{ page.version.version }}/known-limitations.md %}#adding-a-column-with-sequence-based-default-values). For more information, see the. |
Contributor
There was a problem hiding this comment.
please remove the "for more information, see the." sentence entirely - here and on all other versions where it appears
| If you have corrupted data in a database or table, [restore]({% link {{ page.version.version }}/restore.md %}) the object from a prior [backup]({% link {{ page.version.version }}/backup.md %}). If revision history is in the backup, you can restore from a [point in time]({% link {{ page.version.version }}/take-backups-with-revision-history-and-restore-from-a-point-in-time.md %}). | ||
|
|
||
| Instead of dropping the corrupted table or database, we recommend [renaming the table]({% link {{ page.version.version }}/alter-table.md %}#rename-to) or [renaming the database]({% link {{ page.version.version }}/alter-database.md %}#rename-to) so you have historical data to compare to later. If you drop a database, the database cannot be referenced with `AS OF SYSTEM TIME` queries (see [#51380](https://github.com/cockroachdb/cockroach/issues/51380) for more information), and you will need to take a backup that is backdated to the system time when the database still existed. | ||
| Instead of dropping the corrupted table or database, we recommend [renaming the table]({% link {{ page.version.version }}/alter-table.md %}#rename-to) or [renaming the database]({% link {{ page.version.version }}/alter-database.md %}#rename-to) so you have historical data to compare to later. If you drop a database, the database cannot be referenced with `AS OF SYSTEM TIME` queries (see #51380 for more information), and you will need to take a backup that is backdated to the system time when the database still existed. |
Contributor
There was a problem hiding this comment.
please remove the parenthetical "(see #51380 for more information)" entirely, here and everywhere else it may appear on other versions of this doc
|
|
||
| {{site.data.alerts.callout_info}} | ||
| The non-aggregate version of `ST_Union` is not yet implemented. For more information, see [cockroach#49064](https://github.com/cockroachdb/cockroach/issues/49064). | ||
| The non-aggregate version of `ST_Union` is not yet implemented. For more information, see cockroach#49064. |
Contributor
There was a problem hiding this comment.
please remove the entire sentence "For more information ..." here and on all other versions of this page
| ### Temporary objects | ||
|
|
||
| [Temporary tables]({% link {{ page.version.version }}/temporary-tables.md %}), [temporary views]({% link {{ page.version.version }}/views.md %}#temporary-views), and [temporary sequences]({% link {{ page.version.version }}/create-sequence.md %}#temporary-sequences) are in preview in CockroachDB. If you create too many temporary objects in a session, the performance of DDL operations will degrade. Performance limitations could persist long after creating the temporary objects. For more details, see [cockroachdb/cockroach#46260](https://github.com/cockroachdb/cockroach/issues/46260). | ||
| [Temporary tables]({% link {{ page.version.version }}/temporary-tables.md %}), [temporary views]({% link {{ page.version.version }}/views.md %}#temporary-views), and [temporary sequences]({% link {{ page.version.version }}/create-sequence.md %}#temporary-sequences) are in preview in CockroachDB. If you create too many temporary objects in a session, the performance of DDL operations will degrade. Performance limitations could persist long after creating the temporary objects. For more details, see cockroachdb/cockroach#46260. |
Contributor
There was a problem hiding this comment.
removing the link target is not sufficient. please remove the entire "for more details, see cockroachdb/cockroach ..." sentence here and on all other versions of this page
| Note the following limitations of identity columns: | ||
|
|
||
| - `GENERATED ALWAYS AS IDENTITY`/`GENERATED BY DEFAULT AS IDENTITY` is supported in [`ALTER TABLE ... ADD COLUMN`]({% link {{ page.version.version }}/alter-table.md %}#add-column) statements only when the table being altered is empty, as [CockroachDB does not support back-filling sequential column data]({% link {{ page.version.version }}/known-limitations.md %}#adding-a-column-with-sequence-based-default-values). For more information, see [#42508](https://github.com/cockroachdb/cockroach/issues/42508). | ||
| - `GENERATED ALWAYS AS IDENTITY`/`GENERATED BY DEFAULT AS IDENTITY` is supported in [`ALTER TABLE ... ADD COLUMN`]({% link {{ page.version.version }}/alter-table.md %}#add-column) statements only when the table being altered is empty, as [CockroachDB does not support back-filling sequential column data]({% link {{ page.version.version }}/known-limitations.md %}#adding-a-column-with-sequence-based-default-values). For more information, see #42508. |
Contributor
There was a problem hiding this comment.
please remove "for more information, see ..." entirely here and on all other versions of this page.
| {% comment %}v22.2.0+{% endcomment %} | ||
|
|
||
| On macOS ARM systems, [spatial features]({% link {{ page.version.version }}/spatial-data-overview.md %}) are disabled due to an issue with macOS code signing for the <a href="https://libgeos.org/">GEOS</a> libraries. Users needing spatial features on an ARM Mac may instead [run the Intel binary](#install-the-binary) or use the[Docker container image](#use-docker). Refer to [GitHub issue #93161](https://github.com/cockroachdb/cockroach/issues/93161)</a> for more information. | ||
| On macOS ARM systems, [spatial features]({% link {{ page.version.version }}/spatial-data-overview.md %}) are disabled due to an issue with macOS code signing for the <a href="https://libgeos.org/">GEOS</a> libraries. Users needing spatial features on an ARM Mac may instead [run the Intel binary](#install-the-binary) or use the[Docker container image](#use-docker). Refer to GitHub issue #93161</a> for more information. |
Contributor
There was a problem hiding this comment.
please remove the entire sentence "Refer to github issue ..." here and on all other versions of this page
in general, removing link targets is not sufficient. sentences need to be revised to remove clauses that reference the issues, or deleted entirely in some cases
rmloveland
requested changes
May 26, 2026
Contributor
rmloveland
left a comment
rmloveland
left a comment
There was a problem hiding this comment.
@ebembi-crdb this one is close, just found a few remaining things - see my latest round of comments
once you fix the latest round of comments, please port all of these changes forward to v26.3 as well
Remove entire sentences/clauses referencing GitHub issues that were left behind after link removal. Per reviewer feedback, removing only the link target is insufficient — the surrounding text must also be cleaned up. Changes include: - Remove "For more information, see #XXXXX" sentences across all versions - Remove "For more details, see cockroachdb/cockroach#XXXXX" in feature-availability pages - Remove "Refer to GitHub issue #XXXXX" in install-cockroachdb-mac - Remove "GitHub issue tracking X support" from sql-feature-support - Remove tracking issue references from temporary-tables, views, create-sequence - Replace GitHub meta-issue reference with Support link in query-spatial-data - Apply same treatment to v26.3 pages and _includes 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 ASAP
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
#NNNNNreference text; only the hyperlinks are removedThis is PR 3 of 10 splitting #23256 into reviewable chunks.
Jira: DOC-17057
Test plan
🤖 Generated with Claude Code