Skip to content

Commit b03cc5a

Browse files
committed
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 - 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
1 parent 1d65bce commit b03cc5a

14 files changed

Lines changed: 17 additions & 17 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Java Driver for Scylla and Apache Cassandra®
22

3-
[![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)
3+
[![Maven Central](https://img.shields.io/maven-central/v/com.scylladb/java-driver-core)](https://central.sonatype.com/artifact/com.scylladb/java-driver-core)
44

55
*If you're reading this on github.com, please note that this is the readme for the development
66
version and that some features described here might not yet have been released. You can find the

faq/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ This ability is considered a misfeature and has been removed from driver 4.0 onw
100100
However, due to popular demand, cross-datacenter failover has been brought back to driver 4 in
101101
version 4.10.0.
102102

103-
If you are using a driver version >= 4.10.0, read the [manual](../manual/core/loadbalancing/) to
103+
If you are using a driver version >= 4.10.0, read the [manual](../manual/core/load_balancing/) to
104104
understand how to enable this feature; for driver versions < 4.10.0, this feature is simply not
105105
available.
106106

manual/core/graalvm/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ under the License.
2929
* When using LZ4 [compression](../compression/);
3030
* Depending on the [logging backend](../logging) in use.
3131
* DSE-specific features:
32-
* [Geospatial types](../dse/geotypes) are supported.
33-
* [DSE Graph](../dse/graph) is not officially supported, although it may work.
32+
* Geospatial types are supported.
33+
* DSE Graph is not officially supported, although it may work.
3434
* The [shaded jar](../shaded_jar) is not officially supported, although it may work.
3535

3636
-----
@@ -120,7 +120,7 @@ resources are all automatically included in the native image: you should not nee
120120
manually_. See [Accessing Resources in Native Images] for more information on how classpath
121121
resources are handled in native images.
122122

123-
[Accessing Resources in Native Images]: https://www.graalvm.org/reference-manual/native-image/Resources/
123+
[Accessing Resources in Native Images]: https://www.graalvm.org/latest/reference-manual/native-image/metadata/#resources
124124

125125
### Configuring the logging backend
126126

manual/core/load_balancing/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -288,10 +288,10 @@ infrastructure. To resume our example above, if Region1 goes down, the load bala
288288
infrastructure would transparently switch all the traffic intended for that region to Region2,
289289
possibly scaling up its bandwidth to cope with the network traffic spike. This is by far the best
290290
solution for the cross-datacenter failover issue in general, but we acknowledge that it also
291-
requires a purpose-built infrastructure. To help you explore this option, read our [white paper].
291+
requires a purpose-built infrastructure. To help you explore this option, watch our [white paper].
292292

293293
[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
294-
[white paper]: https://www.datastax.com/sites/default/files/content/whitepaper/files/2019-09/Designing-Fault-Tolerant-Applications-DataStax.pdf
294+
[white paper]: https://www.youtube.com/watch?v=NT2-i3u5wo0
295295

296296
#### Token-aware
297297

manual/core/metrics/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -363,6 +363,6 @@ CSV files, SLF4J logs and Graphite. Refer to their [manual][Dropwizard manual] f
363363
[Dropwizard Metrics]: https://metrics.dropwizard.io/4.1.2
364364
[Dropwizard Manual]: https://metrics.dropwizard.io/4.1.2/getting-started.html
365365
[Micrometer Metrics]: https://micrometer.io/docs
366-
[Micrometer JMX]: https://micrometer.io/docs/registry/jmx
366+
[Micrometer JMX]: https://docs.micrometer.io/micrometer/reference/implementations/jmx.html
367367
[MicroProfile Metrics]: https://github.com/eclipse/microprofile-metrics
368368
[reference configuration]: ../configuration/reference/

manual/core/non_blocking/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ For example, calling any synchronous method declared in [`SyncCqlSession`], such
6868
will block until the result is available. These methods should never be used in non-blocking
6969
applications.
7070

71-
[`SyncCqlSession`]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/cql/SyncCqlSession.html`
71+
[`SyncCqlSession`]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/cql/SyncCqlSession.html
7272
[`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-
7373

7474
However, the asynchronous methods declared in [`AsyncCqlSession`], such as [`executeAsync`], are all

manual/core/query_timestamps/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,5 +210,5 @@ Here is the order of precedence of all the methods described so far:
210210

211211
[gettimeofday]: http://man7.org/linux/man-pages/man2/settimeofday.2.html
212212
[JNR]: https://github.com/jnr/jnr-posix
213-
[Lightweight transactions]: https://docs.datastax.com/en/dse/6.0/cql/cql/cql_using/useInsertLWT.html
213+
[Lightweight transactions]: https://cassandra.apache.org/doc/latest/cassandra/developing/cql/dml.html#insert-statement
214214
[Statement.setQueryTimestamp()]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/cql/Statement.html#setQueryTimestamp-long-

manual/core/reactive/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,7 @@ more fine-grained control of what should be retried, and how, is required.
402402
[built-in retry mechanism]: ../retries/
403403
[request throttling]: ../throttling/
404404

405-
[Managing concurrency in asynchronous query execution]: https://docs.datastax.com/en/devapp/doc/devapp/driverManagingConcurrency.html]
405+
[Managing concurrency in asynchronous query execution]: https://docs.datastax.com/en/devapp/doc/devapp/driverManagingConcurrency.html
406406
[Publisher]: https://www.reactive-streams.org/reactive-streams-1.0.2-javadoc/org/reactivestreams/Publisher.html
407407
[reactive streams]: https://en.wikipedia.org/wiki/Reactive_Streams
408408
[Reactive Streams API]: https://github.com/reactive-streams/reactive-streams-jvm

manual/core/statements/batch/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,5 +83,5 @@ to execute such a batch, an `IllegalArgumentException` is thrown.
8383
[BatchStatement]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/cql/BatchStatement.html
8484
[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-
8585
[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-
86-
[batch_dse]: http://docs.datastax.com/en/dse/6.7/cql/cql/cql_using/useBatch.html
86+
[batch_dse]: https://cassandra.apache.org/doc/latest/cassandra/developing/cql/dml.html#batch-statement
8787
[CASSANDRA-10246]: https://issues.apache.org/jira/browse/CASSANDRA-10246

manual/developer/common/concurrency/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ public interface ExecutionInfo {
121121
When a public API method is blocking, this is generally clearly stated in its javadocs.
122122

123123
[`ExecutionInfo.getQueryTrace()`]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/cql/ExecutionInfo.html#getQueryTrace--
124-
[`SyncCqlSession`]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/cql/SyncCqlSession.html`
124+
[`SyncCqlSession`]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/oss/driver/api/core/cql/SyncCqlSession.html
125125

126126
`BlockingOperation` is a utility to check that those methods aren't called on I/O threads, which
127127
could introduce deadlocks.

0 commit comments

Comments
 (0)