Skip to content

Commit 32325c3

Browse files
ebembi-crdbebembi-crdbclaude
authored
DOC-17057: Remove inline cockroach issue/PR links from docs prose (#23306)
* Remove inline cockroach issue/PR links from docs prose 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> * Fix pre-existing cross-version link violations - 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> * Fix image path syntax in st_union.md 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> * fix: remove orphaned reference sentences from docs prose 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> * chore: remove accidentally committed file Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: remove remaining GitHub tracking issue references from docs 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> * fix: repair corrupted code fences causing htmltest anchor failures 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> * Address PR #23306 review feedback: remove residual issue references 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> --------- Co-authored-by: ebembi-crdb <ebembi@cockroachlabs.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 27436f6 commit 32325c3

369 files changed

Lines changed: 595 additions & 926 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
The built-in SQL shell provided with CockroachDB ([`cockroach sql`](cockroach-sql.html) / [`cockroach demo`](cockroach-demo.html)) does not currently support importing data with the `COPY` statement.
22

3-
To load data into CockroachDB, we recommend that you use an [`IMPORT`](import.html). If you must use a `COPY` statement, you can issue the statement from the [`psql` client](https://www.postgresql.org/docs/current/app-psql.html) command provided with PostgreSQL, or from another third-party client.
4-
5-
[Tracking GitHub Issue](https://github.com/cockroachdb/cockroach/issues/16392)
3+
To load data into CockroachDB, we recommend that you use an [`IMPORT`](import.html). If you must use a `COPY` statement, you can issue the statement from the [`psql` client](https://www.postgresql.org/docs/current/app-psql.html) command provided with PostgreSQL, or from another third-party client.

src/current/_includes/v20.2/known-limitations/copy-syntax.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,8 @@ CockroachDB does not yet support the following `COPY` syntax:
22

33
- `COPY ... TO`. To copy data from a CockroachDB cluster to a file, use an [`EXPORT`](export.html) statement.
44

5-
[Tracking GitHub Issue](https://github.com/cockroachdb/cockroach/issues/41608)
6-
75
- `COPY ... FROM CSV`
86

9-
[Tracking GitHub Issue](https://github.com/cockroachdb/cockroach/issues/51891)
10-
117
- `COPY ... FROM STDIN` with a delimiter other than the default tab delimiter.
128

13-
[Tracking GitHub Issue](https://github.com/cockroachdb/cockroach/issues/16407)
14-
15-
- `COPY ... FROM ... WHERE <expr>`
16-
17-
[Tracking GitHub Issue](https://github.com/cockroachdb/cockroach/issues/54580)
9+
- `COPY ... FROM ... WHERE <expr>`
Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
11
When a column is dropped from a multi-column index, the {% if page.name == "cost-based-optimizer.md" %} optimizer {% else %} [optimizer](cost-based-optimizer.html) {% endif %} will not collect new statistics for the deleted column. However, the optimizer never deletes the old [multi-column statistics](create-statistics.html#create-statistics-on-multiple-columns). This can cause a buildup of statistics in `system.table_statistics` leading the optimizer to use stale statistics, which could result in sub-optimal plans. To workaround this issue and avoid these scenarios, explicitly [delete those statistics](create-statistics.html#delete-statistics) from the `system.table_statistics` table.
2-
3-
[Tracking GitHub Issue](https://github.com/cockroachdb/cockroach/issues/67407)

src/current/_includes/v20.2/known-limitations/set-transaction-no-rollback.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,3 @@ timezone
1313
------------
1414
3
1515
~~~
16-
17-
[Tracking GitHub Issue](https://github.com/cockroachdb/cockroach/issues/69396)
Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
11
[Single-column statistics](create-statistics.html#create-statistics-on-a-single-column) are not deleted when columns are dropped, which could cause minor performance issues.
2-
3-
[Tracking GitHub Issue](https://github.com/cockroachdb/cockroach/issues/67407)
Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
11
The [automatic statistics refresher](cost-based-optimizer.html#control-statistics-refresh-rate) automatically checks whether it needs to refresh statistics for every table in the database upon startup of each node in the cluster. If statistics for a table have not been refreshed in a while, this will trigger collection of statistics for that table. If statistics have been refreshed recently, it will not force a refresh. As a result, the automatic statistics refresher does not necessarily perform a refresh of statistics after an [upgrade](upgrade-cockroach-version.html). This could cause a problem, for example, if the upgrade moves from a version without [histograms](cost-based-optimizer.html#control-histogram-collection) to a version with histograms. To refresh statistics manually, use [`CREATE STATISTICS`](create-statistics.html).
2-
3-
[Tracking GitHub Issue](https://github.com/cockroachdb/cockroach/issues/54816)

src/current/_includes/v20.2/known-limitations/unordered-operations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ Unordered aggregation operations do not support disk spilling, and are limited b
44
Setting `--max-sql-memory` too high could result in performance problems due to increased memory consumption.
55
{{site.data.alerts.end}}
66

7-
See the [GitHub tracking issue](https://github.com/cockroachdb/cockroach/issues/42485) for details.
7+
See the for details.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
- `cockroach userfile upload` does not not currently allow for recursive uploads from a directory. This feature will be present with the `--recursive` flag in future versions. [Tracking GitHub Issue](https://github.com/cockroachdb/cockroach/pull/65307)
1+
- `cockroach userfile upload` does not not currently allow for recursive uploads from a directory. This feature will be present with the `--recursive` flag in future versions.

src/current/_includes/v20.2/orchestration/start-cockroachdb-helm-secure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ The CockroachDB Helm chart is undergoing maintenance for compatibility with Kube
33
{{site.data.alerts.end}}
44

55
{{site.data.alerts.callout_info}}
6-
Secure CockroachDB deployments on Amazon EKS via Helm are [not yet supported](https://github.com/cockroachdb/cockroach/issues/38847).
6+
Secure CockroachDB deployments on Amazon EKS via Helm are not yet supported.
77
{{site.data.alerts.end}}
88

99
1. [Install the Helm client](https://helm.sh/docs/intro/install) (version 3.0 or higher) and add the `cockroachdb` chart repository:
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +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).
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.

0 commit comments

Comments
 (0)