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 |
480e9d7 to
faafe05
Compare
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
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.
faafe05 to
1766679
Compare
|
@nikagra Thank you for helping out with this. |
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.