docs: fix 17 broken links in manual, FAQ, and upgrade guide#926
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (14)
✅ Files skipped from review due to trivial changes (11)
🚧 Files skipped from review as they are similar to previous changes (2)
📝 WalkthroughWalkthroughThis PR fixes 17 broken links across the documentation, as identified by an automated link-check workflow. Changes include: updating the Maven Central badge URL to 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
nikagra
force-pushed
the
fix/broken-links-204
branch
from
480e9d7 to
faafe05
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@manual/core/statements/batch/README.md`:
- Line 86: The batch_dse link reference in the README.md file points to a
non-existent anchor on the target Apache Cassandra documentation page. Update
the URL in the batch_dse link definition to reference the correct Apache
Cassandra CQL documentation page where the BATCH statement is actually
documented, removing or correcting the anchor reference that does not exist on
the DML page. Verify the corrected link resolves to the actual BATCH statement
documentation in the Apache Cassandra CQL reference.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 9ca8e671-89fa-40a7-b91e-67bac85c7991
📒 Files selected for processing (14)
README.mdfaq/README.mdmanual/core/graalvm/README.mdmanual/core/load_balancing/README.mdmanual/core/metrics/README.mdmanual/core/non_blocking/README.mdmanual/core/query_timestamps/README.mdmanual/core/reactive/README.mdmanual/core/statements/batch/README.mdmanual/developer/common/concurrency/README.mdmanual/developer/netty_pipeline/README.mdmanual/mapper/daos/queryprovider/README.mdmanual/mapper/entities/README.mdupgrade_guide/README.md
| [BatchStatement.newInstance()]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/cql/BatchStatement.html#newInstance-com.datastax.oss.driver.api.core.cql.BatchType- | ||
| [BatchStatement.builder()]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/cql/BatchStatement.html#builder-com.datastax.oss.driver.api.core.cql.BatchType- | ||
| [batch_dse]: http://docs.datastax.com/en/dse/6.7/cql/cql/cql_using/useBatch.html | ||
| [batch_dse]: https://cassandra.apache.org/doc/latest/cassandra/developing/cql/dml.html#batch_statement |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
Does the URL https://cassandra.apache.org/doc/latest/cassandra/developing/cql/dml.html#batch_statement exist and contain batch statement documentation?
💡 Result:
The URL https://cassandra.apache.org/doc/latest/cassandra/developing/cql/dml.html exists and is the official documentation page for Data Manipulation Language (DML) in Apache Cassandra [1][2]. However, this specific URL does not contain an anchor or section titled #batch_statement. While the page covers DML operations such as INSERT, UPDATE, and SELECT [1][2], the BATCH statement is documented separately within the CQL reference sections of the Apache Cassandra documentation [3][4]. The BATCH statement in CQL is a distinct command used to group multiple DML statements into a single atomic operation [5][6]. If you are looking for technical information regarding the BatchStatement class in the Apache Cassandra codebase, that is found in the project's Javadoc [7] or source code repository [8], rather than the user-facing CQL documentation.
Citations:
- 1: https://cassandra.apache.org/doc/latest/cassandra/developing/cql/dml.html
- 2: https://cassandra.apache.org/doc/5.0.8/cassandra/developing/cql/dml.html
- 3: https://cassandra.apache.org/doc/5.0.8/cassandra/developing/cql/cql_singlefile.html
- 4: https://svn.apache.org/repos/asf/cassandra/site/publish/doc/latest/cql/index.html
- 5: https://docs.datastax.com/en/cql-oss/3.3/cql/cql_reference/cqlBatch.html
- 6: https://docs.datastax.com/en/cql-oss/3.1/cql/cql_reference/batch_r.html
- 7: https://javadoc.io/static/org.apache.cassandra/cassandra-all/4.1.7/org/apache/cassandra/cql3/statements/BatchStatement.html
- 8: https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/cql3/statements/BatchStatement.java
Fix the batch statement documentation link — the anchor does not exist on the target page.
The URL https://cassandra.apache.org/doc/latest/cassandra/developing/cql/dml.html#batch_statement references a non-existent anchor. While the base DML page exists, the BATCH statement is documented separately in the Apache Cassandra CQL reference sections. Update the link to point to the correct location containing batch statement documentation.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@manual/core/statements/batch/README.md` at line 86, The batch_dse link
reference in the README.md file points to a non-existent anchor on the target
Apache Cassandra documentation page. Update the URL in the batch_dse link
definition to reference the correct Apache Cassandra CQL documentation page
where the BATCH statement is actually documented, removing or correcting the
anchor reference that does not exist on the DML page. Verify the corrected link
resolves to the actual BATCH statement documentation in the Apache Cassandra CQL
reference.
There was a problem hiding this comment.
🤖: The anchor does exist on the page — verified by fetching the HTML directly:
$ curl -s "https://cassandra.apache.org/doc/latest/cassandra/developing/cql/dml.html" | grep -oP 'id="[^"]*batch[^"]*"'
id="batch_statement"The original URL in the source used #batch-statement (hyphen), which was indeed broken. This commit corrects it to #batch_statement (underscore), which matches the actual anchor on the page. The linkcheck run that preceded this squash confirmed it resolves correctly.
There was a problem hiding this comment.
Same here: provide a link to ScyllaDB resources.
The BATCH statement: https://docs.scylladb.com/manual/stable/cql/dml/batch.html
There was a problem hiding this comment.
Done — updated to https://docs.scylladb.com/manual/stable/cql/dml/batch.html.
|
|
||
| [application-level failover example]: https://github.com/scylladb/java-driver/blob/scylla-4.x/examples/src/main/java/com/datastax/oss/driver/examples/failover/CrossDatacenterFailover.java | ||
| [white paper]: https://www.datastax.com/sites/default/files/content/whitepaper/files/2019-09/Designing-Fault-Tolerant-Applications-DataStax.pdf | ||
| [white paper]: https://www.youtube.com/watch?v=NT2-i3u5wo0 |
There was a problem hiding this comment.
I would remove this link.
- We should avoid adding links to unstable resources such as videos on YouTube. Such links tend to be broken again sooner or later.
- The content on YouTube is not a white paper. And it's definitely not ours (it's by DataStax). We should promote ScyllaDB resources.
There was a problem hiding this comment.
Done — removed the entire sentence ("To help you explore this option, watch our [white paper].") and deleted the [white paper] link definition. The paragraph now ends at "requires a purpose-built infrastructure."
| [gettimeofday]: http://man7.org/linux/man-pages/man2/settimeofday.2.html | ||
| [JNR]: https://github.com/jnr/jnr-posix | ||
| [Lightweight transactions]: https://docs.datastax.com/en/dse/6.0/cql/cql/cql_using/useInsertLWT.html | ||
| [Lightweight transactions]: https://cassandra.apache.org/doc/latest/cassandra/developing/cql/dml.html#insert-statement |
There was a problem hiding this comment.
We should provide links to ScyllaDB resources that we control, not external resources.
For the INSERT statement: https://docs.scylladb.com/manual/stable/cql/dml/insert.html
There was a problem hiding this comment.
Done — updated to https://docs.scylladb.com/manual/stable/cql/dml/insert.html.
| [@GetEntity]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/mapper/annotations/GetEntity.html | ||
| [@Query]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/mapper/annotations/Query.html | ||
| [aliases]: http://cassandra.apache.org/doc/latest/cql/dml.html?#aliases | ||
| [aliases]: https://cassandra.apache.org/doc/latest/cassandra/developing/cql/dml.html#aliases |
There was a problem hiding this comment.
Please use links to ScyllaDB resources: https://docs.scylladb.com/manual/stable/cql/dml/select.html#aliases
There was a problem hiding this comment.
Done — updated to https://docs.scylladb.com/manual/stable/cql/dml/select.html#aliases.
annastuchlik
left a comment
annastuchlik
left a comment
There was a problem hiding this comment.
I've left some comments.
As a rule, we should avoid linking to external resources if corresponding ScyllaDB resources exist.
Fixes scylladb/scylladb-docs-homepage#204 Straightforward fixes (typos / moved pages): - faq/README.md, upgrade_guide/README.md: loadbalancing -> load_balancing path - manual/core/non_blocking/README.md: remove trailing backtick from SyncCqlSession URL - manual/developer/common/concurrency/README.md: same trailing backtick fix - manual/core/reactive/README.md: remove trailing ] from DataStax devapp URL - manual/core/statements/batch/README.md: http -> https; replace dead DSE 6.7 batch URL with canonical Cassandra CQL DML docs (#batch_statement anchor) - manual/core/query_timestamps/README.md: replace dead DSE 6.0 LWT URL with canonical Cassandra CQL DML docs - manual/mapper/entities/README.md: fix malformed ?# anchor and update to current Cassandra DML docs URL - manual/mapper/daos/queryprovider/README.md: add missing /entity/ path segment in EntityHelper Javadoc URL Opinionated fixes (replacement content chosen): - README.md: replace defunct maven-badges.herokuapp.com badge with shields.io pointing to central.sonatype.com - manual/core/load_balancing/README.md: replace dead DataStax fault-tolerance whitepaper PDF with YouTube video (https://www.youtube.com/watch?v=NT2-i3u5wo0) - manual/core/graalvm/README.md: update GraalVM native-image resources URL to current path; drop hyperlinks from DSE geotypes and DSE Graph entries (pages do not exist in the Scylla driver docs) - manual/core/metrics/README.md: update Micrometer JMX registry URL to current docs.micrometer.io path - manual/developer/netty_pipeline/README.md: rename '### InFlightHandler' heading to '### In-Flight Handler' to match the existing anchor reference in request_execution/README.md Verified clean (for these changes) via local `make -C docs linkcheck` run.
nikagra
force-pushed
the
fix/broken-links-204
branch
from
faafe05 to
1766679
Compare
2 participants
Fixes scylladb/scylladb-docs-homepage#204
Summary
Repairs all 17 broken links identified in the docs-homepage issue. Changes fall into two categories.
Straightforward fixes (typos / moved pages)
faq/README.md,upgrade_guide/README.mdloadbalancing→load_balancingpath segmentmanual/core/non_blocking/README.mdSyncCqlSessionURLmanual/developer/common/concurrency/README.mdmanual/core/reactive/README.md]from DataStax devapp URLmanual/core/statements/batch/README.mdhttp://→https://; replace dead DSE 6.7 batch page with canonical Cassandra CQL DML docsmanual/core/query_timestamps/README.mdmanual/mapper/entities/README.md?#aliasesanchor and update to current Cassandra DML docs URLmanual/mapper/daos/queryprovider/README.md/entity/path segment inEntityHelperJavadoc URLOpinionated fixes (replacement content chosen)
README.mdmaven-badges.herokuapp.combadge withshields.iolinking tocentral.sonatype.commanual/core/load_balancing/README.mdhttps://www.youtube.com/watch?v=NT2-i3u5wo0)manual/core/graalvm/README.mdmanual/core/metrics/README.mdmicrometer.io/docs/registry/jmxtodocs.micrometer.io/micrometer/reference/implementations/jmx.htmlmanual/developer/netty_pipeline/README.md### InFlightHandlerheading →### In-Flight Handlerrequest_execution/README.mdalready uses anchor#in-flight-handler; this aligns the heading to itVerification
Validated via a local
make -C docs linkcheckrun. The run also surfaced 18 additional pre-existing broken links unrelated to this PR; those are tracked separately in scylladb/scylladb-docs-homepage#220.