Skip to content

Commit 34e5546

Browse files
committed
Fix broken links in reference documentation.
Closes #1345
1 parent 56c3999 commit 34e5546

8 files changed

+38
-37
lines changed

src/main/asciidoc/index.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,15 @@ ifdef::backend-epub3[:front-cover-image: image:epub-cover.png[Front Cover,1050,1
77
:example-root: ../../../spring-data-cassandra/src/test/java/org/springframework/data/cassandra/example
88
:example-resources: ../../../spring-data-cassandra/src/test/resources/org/springframework/data/cassandra/example
99
:tabsize: 2
10-
:spring-framework-docs: https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/
1110

12-
(C) 2008-2022 The original author(s).
11+
(C) 2008-2023 The original author(s).
1312

1413
NOTE: Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically.
1514

1615
include::preface.adoc[]
16+
1717
include::{spring-data-commons-docs}/dependencies.adoc[leveloffset=+1]
18+
1819
include::{spring-data-commons-docs}/repositories.adoc[leveloffset=+1]
1920

2021
[[reference]]

src/main/asciidoc/preface.adoc

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
The Spring Data for Apache Cassandra project applies core Spring concepts to the development of solutions using the Cassandra Columnar data store.
55
A "`template`" is provided as a high-level abstraction for storing and querying documents.
6-
This project has noticeable similarities to the {spring-framework-docs}data-access.html#jdbc[JDBC support]
6+
This project has noticeable similarities to the {springDocsUrl}data-access.html#jdbc[JDBC support]
77
in the core Spring Framework.
88

99
This document is the reference guide for Spring Data support for Cassandra.
@@ -15,16 +15,16 @@ The rest of the document refers only to Spring Data for Apache Cassandra feature
1515
[[get-started:first-steps:spring]]
1616
== Knowing Spring
1717

18-
Spring Data uses the Spring Framework's {spring-framework-docs}core.html[core]
18+
Spring Data uses the Spring Framework's {springDocsUrl}core.html[core]
1919
functionality, including:
2020

21-
* {spring-framework-docs}core.html#beans[IoC] container
22-
* {spring-framework-docs}core.html#validation[validation, type conversion and data binding]
23-
* {spring-framework-docs}core.html#expressions[expression language]
24-
* {spring-framework-docs}core.html#aop[AOP]
25-
* {spring-framework-docs}integration.html#jmx[JMX integration]
26-
* {spring-framework-docs}data-access.html[DAO support]
27-
* {spring-framework-docs}data-access.html#dao-exceptions[DAO Exception Hierarchy]
21+
* {springDocsUrl}core.html#beans[IoC] container
22+
* {springDocsUrl}core.html#validation[validation, type conversion and data binding]
23+
* {springDocsUrl}core.html#expressions[expression language]
24+
* {springDocsUrl}core.html#aop[AOP]
25+
* {springDocsUrl}integration.html#jmx[JMX integration]
26+
* {springDocsUrl}data-access.html[DAO support]
27+
* {springDocsUrl}data-access.html#dao-exceptions[DAO Exception Hierarchy]
2828

2929
While it is not important to know the Spring APIs, understanding the concepts behind them is important.
3030
At a minimum, the idea behind IoC should be familiar, no matter what IoC container you choose to use.
@@ -33,10 +33,10 @@ The core functionality of the Cassandra support can be used directly, with no ne
3333
This is much like `JdbcTemplate`, which can be used 'standalone' without any other services of the Spring container.
3434
To use all the features of Spring Data for Apache Cassandra, such as the repository support, you must configure some parts of the library by using Spring.
3535

36-
To learn more about Spring, you can refer to the comprehensive {spring-framework-docs}[documentation]
36+
To learn more about Spring, you can refer to the comprehensive {springDocsUrl}[documentation]
3737
that explains the Spring Framework in detail.
3838
There are a lot of articles, blog entries, and books on Spring.
39-
See the Spring Framework https://projects.spring.io/spring-framework/[home page] for more information.
39+
See the Spring Framework https://spring.io/projects/spring-framework[home page] for more information.
4040

4141
[[get-started:first-steps:nosql]]
4242
== Knowing NoSQL and Cassandra
@@ -50,9 +50,8 @@ It usually does not take more then 5-10 minutes to go through them, and, if you
5050
The starting point for learning about Cassandra is https://cassandra.apache.org/[cassandra.apache.org].
5151
Also, here is a list of other useful resources:
5252

53-
* The https://datastax.com/[DataStax] site offers https://www.datastax.com/what-we-offer/products-services/support[commercial support]
54-
and many resources, including, but not limited to, https://docs.datastax.com/en/landing_page/doc/landing_page/current.html[documentation],
55-
https://docs.datastax.com/en/landing_page/doc/landing_page/current.html[DataStax Academy], a https://www.datastax.com/dev/blog[Tech Blog], and so on.
53+
* The https://datastax.com/[DataStax] site offers https://www.datastax.com/products/datastax-enterprise[commercial support]
54+
and many resources, including, but not limited to, https://docs.datastax.com/en/home/docs/index.html[documentation], and https://docs.datastax.com/en/home/docs/index.html[DataStax Academy].
5655
* The https://academy.datastax.com/resources/ds101-introduction-cassandra[DataStax Academy introduction to Cassandra].
5756
* The https://cassandra.apache.org/doc/latest/getting_started/index.html[Cassandra Quick Start Guide].
5857

@@ -83,7 +82,7 @@ https://pivotal.io/[Pivotal Software, Inc.], the company behind Spring Data and
8382
[[get-started:up-to-date]]
8483
=== Following Development
8584

86-
For information on the Spring Data for Apache Cassandra source code repository, nightly builds, and snapshot artifacts see the https://projects.spring.io/spring-data-cassandra/[Spring Data for Apache Cassandra home page].
85+
For information on the Spring Data for Apache Cassandra source code repository, nightly builds, and snapshot artifacts see the https://spring.io/projects/spring-data-cassandra[Spring Data for Apache Cassandra home page].
8786
You can help make Spring Data best serve the needs of the Spring community by interacting with developers through the community on https://stackoverflow.com/questions/tagged/spring-data[Stack Overflow].
8887
To follow developer activity, look for the mailing list information on the Spring Data for Apache Cassandra home page.
8988
If you encounter a bug or want to suggest an improvement, please create a ticket on the Spring Data issue
@@ -96,6 +95,6 @@ Finally, you can follow the Spring https://spring.io/blog[blog] or the project
9695

9796
* Version Control: https://github.com/spring-projects/spring-data-cassandra
9897
* Bugtracker: https://github.com/spring-projects/spring-data-cassandra/issues
99-
* Release repository: https://repo.spring.io/libs-release
100-
* Milestone repository: https://repo.spring.io/libs-milestone
101-
* Snapshot repository: https://repo.spring.io/libs-snapshot
98+
* Release repository: https://repo1.maven.org/maven2/
99+
* Milestone repository: https://repo.spring.io/milestone/
100+
* Snapshot repository: https://repo.spring.io/snapshot/

src/main/asciidoc/reference/cassandra-repositories.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,7 @@ public interface PersonRepository extends CrudRepository<Person, String> {
328328
----
329329
====
330330

331-
The DataStax Cassandra documentation includes https://docs.datastax.com/en/cassandra/3.0/cassandra/dml/dmlConfigConsistency.html[a good discussion of the available consistency levels].
331+
The DataStax Cassandra documentation includes https://docs.datastax.com/en/cassandra-oss/3.0/cassandra/dml/dmlConfigConsistency.html[a good discussion of the available consistency levels].
332332

333333
NOTE: You can control fetch size, consistency level, and retry policy defaults by configuring the following parameters on the CQL API instances: `CqlTemplate`, `AsyncCqlTemplate`, and `ReactiveCqlTemplate`.
334334
Defaults apply if the particular query option is not set.
@@ -338,7 +338,7 @@ Defaults apply if the particular query option is not set.
338338

339339
Instances of the repository interfaces are usually created by a container, and the Spring container is the most natural choice when working with Spring Data.
340340
Spring Data for Apache Cassandra ships with a custom CDI extension that allows using the repository abstraction in CDI environments.
341-
The extension is part of the JAR. To activate it, drop the Spring Data for Apache Cassandra JAR into your classpath.
341+
The extension is part of the JAR.To activate it, drop the Spring Data for Apache Cassandra JAR into your classpath.
342342
You can now set up the infrastructure by implementing a CDI Producer for the
343343
`CassandraTemplate`, as the following examlpe shows:
344344

src/main/asciidoc/reference/cassandra.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Spring Data support for Apache Cassandra contains a wide range of features:
66
* Spring configuration support with Java-based `@Configuration` classes or the XML namespace.
77
* The `CqlTemplate` helper class that increases productivity by properly handling common Cassandra data access operations.
88
* The `CassandraTemplate` helper class that provides object mapping between CQL Tables and POJOs.
9-
* Exception translation into Spring's portable {spring-framework-docs}data-access.html#dao-exceptions[Data Access Exception Hierarchy].
10-
* Feature rich object mapping integrated with _Spring's_ {spring-framework-docs}core.html#core-convert[Conversion Service].
9+
* Exception translation into Spring's portable {springDocsUrl}data-access.html#dao-exceptions[Data Access Exception Hierarchy].
10+
* Feature rich object mapping integrated with _Spring's_ {springDocsUrl}core.html#core-convert[Conversion Service].
1111
* Annotation-based mapping metadata that is extensible to support other metadata formats.
1212
* Java-based query, criteria, and update DSLs.
1313
* Automatic implementation of `Repository` interfaces including support for custom finder methods.
@@ -19,7 +19,7 @@ Spring Data for Apache Cassandra uses consistent naming conventions on objects i
1919
== Getting Started
2020

2121
Spring Data for Apache Cassandra requires Apache Cassandra 2.1 or later and Datastax Java Driver 4.0 or later.
22-
An easy way to quickly set up and bootstrap a working environment is to create a Spring-based project in https://spring.io/tools/sts[STS] or use https://start.spring.io/[Spring Initializer].
22+
An easy way to quickly set up and bootstrap a working environment is to create a Spring-based project in https://spring.io/tools[Spring Tools] or use https://start.spring.io/[Spring Initializer].
2323

2424
First, you need to set up a running Apache Cassandra server.
2525
See the
@@ -116,7 +116,7 @@ These are discussed in the following sections.
116116

117117
NOTE: For those not familiar with how to configure the Spring container using Java-based bean metadata instead of XML-based metadata, see the high-level introduction in the reference docs
118118
https://docs.spring.io/spring/docs/3.2.x/spring-framework-reference/html/new-in-3.0.html#new-java-configuration[here]
119-
as well as the detailed documentation {spring-framework-docs}core.html#beans-java-instantiating-container[here].
119+
as well as the detailed documentation {springDocsUrl}core.html#beans-java-instantiating-container[here].
120120

121121
[[cassandra.cassandra-java-config]]
122122
=== Registering a Session Instance by Using Java-based Metadata
@@ -136,7 +136,7 @@ This approach lets you use the standard `com.datastax.oss.driver.api.core.CqlSes
136136
An alternative is to register an instance of `com.datastax.oss.driver.api.core.CqlSession` with the container by using Spring's `CqlSessionFactoryBean`.
137137
As compared to instantiating a `com.datastax.oss.driver.api.core.CqlSession` instance directly, the `FactoryBean` approach has the added advantage of also providing the container with an `ExceptionTranslator` implementation that translates Cassandra exceptions to exceptions in Spring's portable `DataAccessException` hierarchy.
138138
This hierarchy and the use of
139-
`@Repository` is described in {spring-framework-docs}data-access.html[Spring's DAO support features].
139+
`@Repository` is described in {springDocsUrl}data-access.html[Spring's DAO support features].
140140

141141
The following example shows Java-based factory class usage:
142142

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
== Exception Translation
22

33
The Spring Framework provides exception translation for a wide variety of database and mapping technologies.
4-
This has traditionally been for JDBC and JPA. Spring Data for Apache Cassandra extends this feature to Apache Cassandra by providing an implementation of the `org.springframework.dao.support.PersistenceExceptionTranslator` interface.
4+
This has traditionally been for JDBC and JPA.
5+
Spring Data for Apache Cassandra extends this feature to Apache Cassandra by providing an implementation of the `org.springframework.dao.support.PersistenceExceptionTranslator` interface.
56

6-
The motivation behind mapping to Spring's {spring-framework-docs}html/dao.html#dao-exceptions[consistent data access exception hierarchy]
7+
The motivation behind mapping to Spring's {springDocsUrl}html/dao.html#dao-exceptions[consistent data access exception hierarchy]
78
is to let you write portable and descriptive exception handling code without resorting to coding against and handling specific Cassandra exceptions.
89
All of Spring's data access exceptions are inherited from the
910
`DataAccessException` class, so you can be sure that you can catch all database-related exceptions within a single try-catch block.

src/main/asciidoc/reference/mapping.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ The following table maps Spring Data types to Cassandra types:
109109
|===
110110

111111
Each supported type maps to a default
112-
https://docs.datastax.com/en/cql/3.3/cql/cql_reference/cql_data_types_c.html[Cassandra data type].
112+
https://docs.datastax.com/en/cql-oss/3.x/cql/cql_reference/cql_data_types_c.html[Cassandra data type].
113113
Java types can be mapped to other Cassandra types by using `@CassandraType`, as the following example shows:
114114

115115
.Enum mapping to numeric types

src/main/asciidoc/reference/reactive-cassandra-repositories.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Reactive usage is broken up into two phases: Composition and Execution.
1010

1111
Calling repository methods lets you compose a reactive sequence by obtaining `Publisher` instances and applying operators.
1212
No I/O happens until you subscribe.
13-
Passing the reactive sequence to a reactive execution infrastructure, such as {spring-framework-docs}web.html#web-reactive[Spring WebFlux]
13+
Passing the reactive sequence to a reactive execution infrastructure, such as {springDocsUrl}web.html#web-reactive[Spring WebFlux]
1414
or https://vertx.io/docs/vertx-reactive-streams/java/[Vert.x]), subscribes to the publisher and initiate the actual execution.
1515
See https://projectreactor.io/docs/core/release/reference/#reactive.subscribe[the Project reactor documentation] for more detail.
1616

src/main/asciidoc/reference/reactive-cassandra.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ The reactive Cassandra support contains a wide range of features:
77
* `ReactiveCqlTemplate` helper class that increases productivity by properly handling common Cassandra data access operations.
88
* `ReactiveCassandraTemplate` helper class that increases productivity by using `ReactiveCassandraOperations` in a reactive manner.
99
It includes integrated object mapping between tables and POJOs.
10-
* Exception translation into Spring's portable {spring-framework-docs}data-access.html#dao-exceptions[Data Access Exception Hierarchy].
11-
* Feature rich object mapping integrated with Spring's {spring-framework-docs}core.html#core-convert[Conversion Service].
10+
* Exception translation into Spring's portable {springDocsUrl}data-access.html#dao-exceptions[Data Access Exception Hierarchy].
11+
* Feature rich object mapping integrated with Spring's {springDocsUrl}core.html#core-convert[Conversion Service].
1212
* Java-based Query, Criteria, and Update DSLs.
1313
* Automatic implementation of `Repository` interfaces, including support for custom finder methods.
1414

@@ -19,7 +19,7 @@ Spring Data for Apache Cassandra uses consistent naming conventions on objects i
1919
== Getting Started
2020

2121
Spring Data for Apache Cassandra requires Apache Cassandra 2.1 or later and Datastax Java Driver 4.0 or later.
22-
An easy way to quickly set up and bootstrap a working environment is to create a Spring-based project in https://spring.io/tools/sts[STS] or use https://start.spring.io/[Spring Initializer].
22+
An easy way to quickly set up and bootstrap a working environment is to create a Spring-based project in https://spring.io/tools[Spring Tools] or use https://start.spring.io/[Spring Initializer].
2323

2424
First, you need to set up a running Apache Cassandra server.
2525
See the
@@ -64,7 +64,7 @@ If using a milestone release instead of a GA release, you also need to add the l
6464
<repository>
6565
<id>spring-milestone</id>
6666
<name>Spring Maven MILESTONE Repository</name>
67-
<url>https://repo.spring.io/libs-milestone</url>
67+
<url>https://repo.spring.io/milestone</url>
6868
</repository>
6969
</repositories>
7070
----
@@ -114,8 +114,8 @@ You can do so either by using Java-based bean metadata or by using XML-based bea
114114
These are discussed in the following sections.
115115

116116
NOTE: For those not familiar with how to configure the Spring container using Java-based bean metadata instead of XML-based metadata, see the high-level introduction in the reference docs
117-
https://docs.spring.io/spring/docs/3.2.x/spring-framework-reference/html/new-in-3.0.html#new-java-configuration[here]
118-
as well as the detailed documentation {spring-framework-docs}core.html#beans-java-instantiating-container[here].
117+
https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#beans-java[here]
118+
as well as the detailed documentation {springDocsUrl}core.html#beans-java-instantiating-container[here].
119119

120120
[[reactive.cassandra.java-config]]
121121
=== Registering a Session instance using Java-based metadata

0 commit comments

Comments
 (0)