Skip to content

Commit cc97ee5

Browse files
committed
CASSANDRA-21342: Long-tail xref follow-up on trunk
Follow-up to the umbrella patch for CASSANDRA-21342 (merged 2026-05-14). Closes the long-tail of trunk xref errors that remained after the first wave landed. Mechanical retargets only; no prose was rewritten and no pages were added or removed. Anchors that did not exist are added with the project's existing [[anchor]] convention. Edit classes: * Module-prefix xrefs: bare/partial paths -> cassandra:-qualified * Moved-page xrefs: retarget to current home on trunk * Filename typo: defintions.adoc -> definitions.adoc * Extension: .html -> .adoc; writetime retargeted to functions.adoc * nodetool xrefs: qualify to cassandra:managing/tools/nodetool/ * Anchors: add three missing [[anchor]] targets and retarget the xrefs that point at them For every still-existing anchor target the destination page and [[anchor]] (or generated section id) were grep-verified on upstream/trunk before the edit. Triage was driven by the 2026-04-21 Antora 3 baseline (Jenkins #2752); patterns where no source file on trunk still references the old target were treated as already-closed and not touched. Build verification: cassandra-website built locally with Antora 3 against this branch as the cassandra source drops trunk-level errors from 161 (baseline) to 3. The three remaining errors are all in cassandra-website source (blog posts + main-nav.adoc) and out of scope for this patch. Drafting and triage were performed with AI assistance (Anthropic Claude); the change set is reviewable as mechanical xref retargets and anchor additions. Source provenance per ASF generative tooling guidance. patch by Patrick McFadin; reviewed by Mick Semb Wever for CASSANDRA-21342
1 parent 6eb2d5d commit cc97ee5

26 files changed

Lines changed: 40 additions & 37 deletions

File tree

doc/modules/cassandra/nav.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@
117117
**** xref:cassandra:managing/tools/cqlsh.adoc[cqlsh: the CQL shell]
118118
**** xref:cassandra:managing/tools/nodetool/nodetool.adoc[nodetool]
119119
**** xref:cassandra:managing/tools/sstable/index.adoc[SSTable tools]
120-
**** xref:cassandra:managing/tools/cassandra_stress.adoc[cassandra-stress]
120+
**** xref:cassandra:tooling/cassandra-stress.adoc[cassandra-stress]
121121

122122

123123
** xref:cassandra:troubleshooting/index.adoc[Troubleshooting]

doc/modules/cassandra/pages/architecture/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ This section describes the general architecture of Apache Cassandra.
66
* xref:architecture/dynamo.adoc[Dynamo]
77
* xref:architecture/storage-engine.adoc[Storage Engine]
88
* xref:architecture/guarantees.adoc[Guarantees]
9-
* xref:architecture/snitch.adoc[Snitches]
9+
* xref:cassandra:managing/operating/snitch.adoc[Snitches]
1010
* xref:architecture/accord.adoc[Accord]

doc/modules/cassandra/pages/architecture/storage-engine.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Once the defined size is reached, a new commit log segment is created.
3030
Commit log segments can be archived, deleted, or recycled once all the data is flushed to
3131
https://cassandra.apache.org/_/glossary.html#sstable[SSTables].
3232
Commit log segments are truncated when Cassandra has written data older than a certain point to the SSTables.
33-
Running xref:managing:tools/nodetool/drain.adoc[`nodetool drain`] before stopping Cassandra will write everything in the memtables
33+
Running xref:cassandra:managing/tools/nodetool/drain.adoc[`nodetool drain`] before stopping Cassandra will write everything in the memtables
3434
to SSTables and remove the need to sync with the commit logs on startup.
3535

3636
* xref:cassandra:managing/configuration/cass_yaml_file.adoc#commitlog_segment_size [`commitlog_segment_size`]: The default size is 32MiB, which is almost always fine, but if you are archiving commitlog segments (see commitlog_archiving.properties), then you probably want a finer granularity of archiving; 8 or 16 MiB is reasonable.
@@ -105,7 +105,7 @@ A partition index is also created on the disk that maps the tokens to a location
105105

106106
The queue can be configured with either the xref:cassandra:managing/configuration/cass_yaml_file.adoc#memtable_heap_space[`memtable_heap_space`] or xref:cassandra:managing/configuration/cass_yaml_file.adoc#memtable_offheap_space[`memtable_offheap_space`] setting in the `cassandra.yaml` file.
107107
If the data to be flushed exceeds the `memtable_cleanup_threshold`, Cassandra blocks writes until the next flush succeeds.
108-
You can manually flush a table using xref:managing:tools/nodetool/flush.adoc[`nodetool flush`] or `nodetool drain` (flushes memtables without listening for connections to other nodes).
108+
You can manually flush a table using xref:cassandra:managing/tools/nodetool/flush.adoc[`nodetool flush`] or `nodetool drain` (flushes memtables without listening for connections to other nodes).
109109
To reduce the commit log replay time, the recommended best practice is to flush the memtable before you restart the nodes.
110110
If a node stops working, replaying the commit log restores writes to the memtable that were there before it stopped.
111111

doc/modules/cassandra/pages/developing/cql/create-custom-index.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Also refer xref:cassandra:developing/cql/indexing/sai/sai-query.adoc[Examine SAI
119119
=== SAI collection map examples with keys, values, and entries
120120

121121
The following examples demonstrate using collection maps of multiple types (`keys`, `values`, `entries`) in SAI indexes.
122-
For related information, see xref:cassandra:developing/cql/collections/collection-create.adoc[Creating collections] and xref:cassandra:developing/collections/map.adoc[Using map type].
122+
For related information, see xref:cassandra:developing/cql/collections/collection-create.adoc[Creating collections] and xref:cassandra:developing/cql/collections/map.adoc[Using map type].
123123

124124
Also refer to the SAI collection examples of type xref:#saiCreateCustomIndexCollectionsListAndSetExamples[list and set] in this topic.
125125

@@ -294,8 +294,8 @@ These examples demonstrate using collections with the `list` and `set` types in
294294
For related information, see:
295295

296296
* xref:cassandra:developing/cql/collections/collection-create.adoc[Creating collections]
297-
* xref:cassandra:developing/collections/list.adoc[Using list type]
298-
* xref:cassandra:developing/collections/set.adoc[Using set type]
297+
* xref:cassandra:developing/cql/collections/list.adoc[Using list type]
298+
* xref:cassandra:developing/cql/collections/set.adoc[Using set type]
299299

300300
[source,language-cql]
301301
----

doc/modules/cassandra/pages/developing/cql/create-index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ After an index has been created, it is automatically updated when data in the co
88
Indexing via this `CREATE INDEX` command can impact performance.
99
Before creating an index, be aware of when and xref:cassandra:developing/cql/indexing/2i/2i-when-to-use.adoc#when-no-index[when not to create an index].
1010

11-
Use xref:cassandra:developing/cql/indexing/create-custom-index.adoc[CREATE CUSTOM INDEX] for Storage-Attached Indexes (SAI).
11+
Use xref:cassandra:developing/cql/create-custom-index.adoc[CREATE CUSTOM INDEX] for Storage-Attached Indexes (SAI).
1212

1313
*Restriction:* Indexing counter columns is not supported.
1414
For maps, index the key, value, or entries.

doc/modules/cassandra/pages/developing/cql/ddl.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ will result in:
166166
include::cassandra:example$RESULTS/autoexpand_exclude_dc.result[]
167167
----
168168

169-
If xref:new/transientreplication.adoc[transient replication] has been enabled, transient replicas can be
169+
If xref:cassandra:managing/operating/transientreplication.adoc[transient replication] has been enabled, transient replicas can be
170170
configured for both `SimpleStrategy` and `NetworkTopologyStrategy` by
171171
defining replication factors in the format
172172
`'<total_replicas>/<transient_replicas>'`

doc/modules/cassandra/pages/developing/cql/definitions.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ include::cassandra:example$BNF/term.bnf[]
118118

119119
A term is thus one of:
120120

121-
* A xref:cassandra:developing/cql/defintions.adoc#constants[constant]
121+
* A xref:cassandra:developing/cql/definitions.adoc#constants[constant]
122122
* A literal for either a xref:cassandra:developing/cql/types.adoc#collections[collection], a xref:cassandra:developing/cql/types.adoc#vectors[vector],
123123
a xref:cassandra:developing/cql/types.adoc#udts[user-defined type] or a xref:cassandra:developing/cql/types.adoc#tuples[tuple]
124124
* A xref:cassandra:developing/cql/functions.adoc#cql-functions[function] call, either a xref:cassandra:developing/cql/functions.adoc#scalar-native-functions[native function]

doc/modules/cassandra/pages/developing/cql/indexing/2i/operations/2i-build.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ Indexes are built in the background automatically, without blocking reads or wri
77
Client-maintained _tables as indexes_ must be created manually;
88
for example, if the artists column had been indexed by creating a table such as `songs_by_artist`, your client application would have to populate the table with data from the songs table.
99

10-
To perform a hot rebuild of an index, use the xref:cassandra:tools/nodetool/rebuild_index.adoc[nodetool rebuild_index] command.
10+
To perform a hot rebuild of an index, use the xref:cassandra:managing/tools/nodetool/rebuild_index.adoc[nodetool rebuild_index] command.

doc/modules/cassandra/pages/developing/cql/indexing/sai/_sai-create.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,4 +76,4 @@ include::cassandra:example$CQL/sai/index-sai-similarity-function.cql[]
7676
'''
7777
Other resources
7878

79-
See xref:developing/cql/indexing/create-custom-index.adoc[CREATE CUSTOM INDEX] for more information about creating SAI indexes.
79+
See xref:cassandra:developing/cql/create-custom-index.adoc[CREATE CUSTOM INDEX] for more information about creating SAI indexes.

doc/modules/cassandra/pages/developing/cql/indexing/sai/operations/configuring.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33

44
// LLP: *NOT DONE*
55

6-
Configuring your {product} environment for Storage-Attached Indexing (SAI) may require some customization of the `cassandra.yaml` file.
6+
Configuring your {product} environment for Storage-Attached Indexing (SAI) may require some customization of the `cassandra.yaml` file.
77

8+
[[saiConfigure__saiCompactionStrategies]]
89
== Compaction strategies
910

1011
Read queries perform better with compaction strategies that produce fewer SSTables.
@@ -20,13 +21,13 @@ While in a time window, TWCS compacts all SSTables flushed from memory into larg
2021
At the end of the time window, all of these SSTables are compacted into a single SSTable.
2122
Then the next time window starts and the process repeats.
2223
The duration of the time window is the only setting required.
23-
See xref:reference:cql-commands/create-table.adoc#compactSubprop__TWCS[TimeWindowCompactionStrategy].
24+
See xref:cassandra:reference/cql-commands/compact-subproperties.adoc#TWCS[TimeWindowCompactionStrategy].
2425
For more information about TWCS, see xref:cassandra:managing/operating/compaction/twcs.adoc[Time Window Compaction Strategy].
2526

2627
In general, do not use `LeveledCompactionStrategy` (LCS) unless your index queries restrict the token range, either directly or by providing a restriction on the partition key.
2728
However, if you decide to use LCS, use the following guidelines:
2829

29-
* The `160` MB default for the `CREATE TABLE` command's `sstable_size_in_mb` option, described in this xref:reference:cql-commands/create-table.adoc#compactSubprop__LCS[topic], may result in suboptimal performance for index queries that do not restrict on token range or partition key.
30+
* The `160` MB default for the `CREATE TABLE` command's `sstable_size_in_mb` option, described in this xref:cassandra:reference/cql-commands/compact-subproperties.adoc#LCS[topic], may result in suboptimal performance for index queries that do not restrict on token range or partition key.
3031
* While even higher values may be appropriate, depending on your hardware, we recommend at least doubling the default value of `sstable_size_in_mb`.
3132

3233
Example:

0 commit comments

Comments
 (0)