From 17666799575f51dc34cfafbe2095695804b10a62 Mon Sep 17 00:00:00 2001 From: Mikita Hradovich Date: Tue, 16 Jun 2026 19:35:33 +0200 Subject: [PATCH] docs: fix 17 broken links in manual, FAQ, and upgrade guide 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. --- README.md | 2 +- faq/README.md | 2 +- manual/core/graalvm/README.md | 6 +++--- manual/core/load_balancing/README.md | 3 +-- manual/core/metrics/README.md | 2 +- manual/core/non_blocking/README.md | 2 +- manual/core/query_timestamps/README.md | 2 +- manual/core/reactive/README.md | 2 +- manual/core/statements/batch/README.md | 2 +- manual/developer/common/concurrency/README.md | 2 +- manual/developer/netty_pipeline/README.md | 2 +- manual/mapper/daos/queryprovider/README.md | 2 +- manual/mapper/entities/README.md | 2 +- upgrade_guide/README.md | 2 +- 14 files changed, 16 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index cc0e3f8fae1..6486d49e10f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Java Driver for Scylla and Apache Cassandra® -[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.scylladb/java-driver-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.scylladb/java-driver-core) +[![Maven Central](https://img.shields.io/maven-central/v/com.scylladb/java-driver-core)](https://central.sonatype.com/artifact/com.scylladb/java-driver-core) *If you're reading this on github.com, please note that this is the readme for the development version and that some features described here might not yet have been released. You can find the diff --git a/faq/README.md b/faq/README.md index 5bd02fab6f6..cf34a0c4334 100644 --- a/faq/README.md +++ b/faq/README.md @@ -100,7 +100,7 @@ This ability is considered a misfeature and has been removed from driver 4.0 onw However, due to popular demand, cross-datacenter failover has been brought back to driver 4 in version 4.10.0. -If you are using a driver version >= 4.10.0, read the [manual](../manual/core/loadbalancing/) to +If you are using a driver version >= 4.10.0, read the [manual](../manual/core/load_balancing/) to understand how to enable this feature; for driver versions < 4.10.0, this feature is simply not available. diff --git a/manual/core/graalvm/README.md b/manual/core/graalvm/README.md index a3ae4c43494..5413c090420 100644 --- a/manual/core/graalvm/README.md +++ b/manual/core/graalvm/README.md @@ -29,8 +29,8 @@ under the License. * When using LZ4 [compression](../compression/); * Depending on the [logging backend](../logging) in use. * DSE-specific features: - * [Geospatial types](../dse/geotypes) are supported. - * [DSE Graph](../dse/graph) is not officially supported, although it may work. + * Geospatial types are supported. + * DSE Graph is not officially supported, although it may work. * The [shaded jar](../shaded_jar) is not officially supported, although it may work. ----- @@ -120,7 +120,7 @@ resources are all automatically included in the native image: you should not nee manually_. See [Accessing Resources in Native Images] for more information on how classpath resources are handled in native images. -[Accessing Resources in Native Images]: https://www.graalvm.org/reference-manual/native-image/Resources/ +[Accessing Resources in Native Images]: https://www.graalvm.org/latest/reference-manual/native-image/metadata/#resources ### Configuring the logging backend diff --git a/manual/core/load_balancing/README.md b/manual/core/load_balancing/README.md index 824affca166..ae4539014e7 100644 --- a/manual/core/load_balancing/README.md +++ b/manual/core/load_balancing/README.md @@ -288,10 +288,9 @@ infrastructure. To resume our example above, if Region1 goes down, the load bala infrastructure would transparently switch all the traffic intended for that region to Region2, possibly scaling up its bandwidth to cope with the network traffic spike. This is by far the best solution for the cross-datacenter failover issue in general, but we acknowledge that it also -requires a purpose-built infrastructure. To help you explore this option, read our [white paper]. +requires a purpose-built infrastructure. [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 #### Token-aware diff --git a/manual/core/metrics/README.md b/manual/core/metrics/README.md index 6f3a16983c4..d46ed58b21c 100644 --- a/manual/core/metrics/README.md +++ b/manual/core/metrics/README.md @@ -363,6 +363,6 @@ CSV files, SLF4J logs and Graphite. Refer to their [manual][Dropwizard manual] f [Dropwizard Metrics]: https://metrics.dropwizard.io/4.1.2 [Dropwizard Manual]: https://metrics.dropwizard.io/4.1.2/getting-started.html [Micrometer Metrics]: https://micrometer.io/docs -[Micrometer JMX]: https://micrometer.io/docs/registry/jmx +[Micrometer JMX]: https://docs.micrometer.io/micrometer/reference/implementations/jmx.html [MicroProfile Metrics]: https://github.com/eclipse/microprofile-metrics [reference configuration]: ../configuration/reference/ \ No newline at end of file diff --git a/manual/core/non_blocking/README.md b/manual/core/non_blocking/README.md index f320ffd13d2..d6b98081645 100644 --- a/manual/core/non_blocking/README.md +++ b/manual/core/non_blocking/README.md @@ -68,7 +68,7 @@ For example, calling any synchronous method declared in [`SyncCqlSession`], such will block until the result is available. These methods should never be used in non-blocking applications. -[`SyncCqlSession`]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/cql/SyncCqlSession.html` +[`SyncCqlSession`]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/cql/SyncCqlSession.html [`execute`]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/cql/SyncCqlSession.html#execute-com.datastax.oss.driver.api.core.cql.Statement- However, the asynchronous methods declared in [`AsyncCqlSession`], such as [`executeAsync`], are all diff --git a/manual/core/query_timestamps/README.md b/manual/core/query_timestamps/README.md index 4498afe21c4..ba703b36945 100644 --- a/manual/core/query_timestamps/README.md +++ b/manual/core/query_timestamps/README.md @@ -210,5 +210,5 @@ Here is the order of precedence of all the methods described so far: [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://docs.scylladb.com/manual/stable/cql/dml/insert.html [Statement.setQueryTimestamp()]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/cql/Statement.html#setQueryTimestamp-long- diff --git a/manual/core/reactive/README.md b/manual/core/reactive/README.md index 37a2e3411b8..3e9c496b219 100644 --- a/manual/core/reactive/README.md +++ b/manual/core/reactive/README.md @@ -402,7 +402,7 @@ more fine-grained control of what should be retried, and how, is required. [built-in retry mechanism]: ../retries/ [request throttling]: ../throttling/ -[Managing concurrency in asynchronous query execution]: https://docs.datastax.com/en/devapp/doc/devapp/driverManagingConcurrency.html] +[Managing concurrency in asynchronous query execution]: https://docs.datastax.com/en/devapp/doc/devapp/driverManagingConcurrency.html [Publisher]: https://www.reactive-streams.org/reactive-streams-1.0.2-javadoc/org/reactivestreams/Publisher.html [reactive streams]: https://en.wikipedia.org/wiki/Reactive_Streams [Reactive Streams API]: https://github.com/reactive-streams/reactive-streams-jvm diff --git a/manual/core/statements/batch/README.md b/manual/core/statements/batch/README.md index f080fe16ab0..e984ce23154 100644 --- a/manual/core/statements/batch/README.md +++ b/manual/core/statements/batch/README.md @@ -83,5 +83,5 @@ to execute such a batch, an `IllegalArgumentException` is thrown. [BatchStatement]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/cql/BatchStatement.html [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://docs.scylladb.com/manual/stable/cql/dml/batch.html [CASSANDRA-10246]: https://issues.apache.org/jira/browse/CASSANDRA-10246 diff --git a/manual/developer/common/concurrency/README.md b/manual/developer/common/concurrency/README.md index fb493930d6e..0707b511cce 100644 --- a/manual/developer/common/concurrency/README.md +++ b/manual/developer/common/concurrency/README.md @@ -121,7 +121,7 @@ public interface ExecutionInfo { When a public API method is blocking, this is generally clearly stated in its javadocs. [`ExecutionInfo.getQueryTrace()`]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/cql/ExecutionInfo.html#getQueryTrace-- -[`SyncCqlSession`]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/cql/SyncCqlSession.html` +[`SyncCqlSession`]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/cql/SyncCqlSession.html `BlockingOperation` is a utility to check that those methods aren't called on I/O threads, which could introduce deadlocks. diff --git a/manual/developer/netty_pipeline/README.md b/manual/developer/netty_pipeline/README.md index b596832e202..43ce23a5408 100644 --- a/manual/developer/netty_pipeline/README.md +++ b/manual/developer/netty_pipeline/README.md @@ -95,7 +95,7 @@ have full control over their network configuration. `HeartbeatHandler` is based on Netty's built-in `IdleStateHandler`, so there's not much in there apart from the details of the control request. -### InFlightHandler +### In-Flight Handler This handler is where most of the connection logic resides. It is responsible for: diff --git a/manual/mapper/daos/queryprovider/README.md b/manual/mapper/daos/queryprovider/README.md index 593a3a6b1a4..c0287cbf82f 100644 --- a/manual/mapper/daos/queryprovider/README.md +++ b/manual/mapper/daos/queryprovider/README.md @@ -161,6 +161,6 @@ Here is the full implementation: [entityHelpers]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/mapper/annotations/QueryProvider.html#entityHelpers-- [providerMethod]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/mapper/annotations/QueryProvider.html#providerMethod-- [MapperContext]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/mapper/MapperContext.html -[EntityHelper]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/mapper/EntityHelper.html +[EntityHelper]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/mapper/entity/EntityHelper.html [ResultSet]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/cql/ResultSet.html [PagingIterable]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/PagingIterable.html diff --git a/manual/mapper/entities/README.md b/manual/mapper/entities/README.md index 978c781245f..f519695b50a 100644 --- a/manual/mapper/entities/README.md +++ b/manual/mapper/entities/README.md @@ -588,7 +588,7 @@ To control how the class hierarchy is scanned, annotate classes with [@Hierarchy [@Update]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/mapper/annotations/Update.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://docs.scylladb.com/manual/stable/cql/dml/select.html#aliases [@Transient]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/mapper/annotations/Transient.html [@TransientProperties]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/mapper/annotations/TransientProperties.html [@HierarchyScanStrategy]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/mapper/annotations/HierarchyScanStrategy.html diff --git a/upgrade_guide/README.md b/upgrade_guide/README.md index d9834828d2a..214399dacc7 100644 --- a/upgrade_guide/README.md +++ b/upgrade_guide/README.md @@ -387,7 +387,7 @@ has been deprecated; it should be replaced with a node distance evaluator class [JAVA-2899](https://datastax-oss.atlassian.net/browse/JAVA-2899) re-introduced the ability to perform cross-datacenter failover using the driver's built-in load balancing policies. See [Load -balancing](../manual/core/loadbalancing/) in the manual for details. +balancing](../manual/core/load_balancing/) in the manual for details. Cross-datacenter failover is disabled by default, therefore existing applications should not experience any disruption.