Skip to content

Commit 1256165

Browse files
SiyaoIsHidingSiyaoIsHiding
committed
fix broken links. substitute links at doc outside /manual
1 parent 9ca4465 commit 1256165

File tree

102 files changed

+1803
-484
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

102 files changed

+1803
-484
lines changed

‎.python-version‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.10.1

‎README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ are multiple modules, all prefixed with `java-driver-`.
4545
Note that the query builder is now published as a separate artifact, you'll need to add the
4646
dependency if you plan to use it.
4747

48-
Refer to each module's manual for more details ([core](manual/core/), [query
49-
builder](manual/query_builder/), [mapper](manual/mapper)).
48+
Refer to each module's manual for more details ([core](/manual/core/README.md), [query
49+
builder](/manual/query_builder/README.md), [mapper](/manual/mapper/README.md)).
5050

5151
[org.apache.cassandra]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.cassandra%22
5252

@@ -65,15 +65,15 @@ but DataStax does not officially support these systems.
6565
Java Driver 4 is **not binary compatible** with previous versions. However, most of the concepts
6666
remain unchanged, and the new API will look very familiar to 2.x and 3.x users.
6767

68-
See the [upgrade guide](upgrade_guide/) for details.
68+
See the [upgrade guide](upgrade_guide/README.md) for details.
6969

7070
## Error Handling
7171

7272
See the [Cassandra error handling done right blog](https://www.datastax.com/blog/cassandra-error-handling-done-right) for error handling with the Java Driver for Apache Cassandra™.
7373

7474
## Useful links
7575

76-
* [Manual](manual/)
76+
* [Manual](/manual/README.md)
7777
* [API docs]
7878
* Bug tracking: [JIRA]
7979
* [Mailing list]
@@ -83,8 +83,8 @@ See the [Cassandra error handling done right blog](https://www.datastax.com/blog
8383
[API docs]: https://docs.datastax.com/en/drivers/java/4.17
8484
[JIRA]: https://issues.apache.org/jira/issues/?jql=project%20%3D%20CASSJAVA%20ORDER%20BY%20key%20DESC
8585
[Mailing list]: https://groups.google.com/a/lists.datastax.com/forum/#!forum/java-driver-user
86-
[Changelog]: changelog/
87-
[FAQ]: faq/
86+
[Changelog]: changelog/README.md
87+
[FAQ]: faq/README.md
8888

8989
## License
9090

‎build-doc.sh‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
set -e
22
# Set up python environment
33
#pyenv local 3.10.1
4-
#pip install mkdocs mkdocs-material pip install mkdocs-awesome-pages-plugin
4+
#pip install mkdocs mkdocs-material mkdocs-awesome-pages-plugin mkdocs-macros-plugin
55

66
# In some bash/zsh environments, the locale is not set correctly, which causes mkdocs to fail.
77
export LC_ALL=en_US.UTF-8
@@ -12,5 +12,19 @@ mvn clean install -DskipTests # or guava-shaded can not be found
1212
# mvn javadoc:javadoc -pl core,query-builder,mapper-runtime
1313
mvn javadoc:aggregate
1414

15+
16+
for f in HOME-README.md faq-README.md upgrade-README.md; do
17+
perl -pi -e 's/\]\(\.\.\/manual\//](manual\//g;
18+
s/\]\(\.\.\/faq\//](faq\//g;
19+
s/\]\(\.\.\/changelog\//](changelog\//g;' "$f"
20+
done
21+
22+
1523
# Build manual with API references
1624
mkdocs build # or `mkdocs serve` to preview
25+
26+
for f in HOME-README.md faq-README.md upgrade-README.md; do
27+
perl -pi -e 's/\]\(manual\//]\(..\/manual\//g;
28+
s/\]\(faq\//]\(..\/faq\//g;
29+
s/\]\(changelog\//]\(..\/changelog\//g;' "$f"
30+
done

‎docs.yaml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The ASF licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
18+
title: Java Driver
19+
summary: Java Driver for Apache Cassandra®
20+
homepage: http://docs.datastax.com/en/developer/java-driver
21+
theme: datastax
22+
sections:
23+
- title: Manual
24+
prefix: /manual
25+
sources:
26+
- type: markdown
27+
files: 'manual/**/*.md'
28+
- title: Reference configuration
29+
prefix: /manual/core/configuration/reference
30+
sources:
31+
- type: rst
32+
files: 'manual/core/configuration/reference/*.rst'
33+
- title: Changelog
34+
prefix: /changelog
35+
sources:
36+
- type: markdown
37+
files: 'changelog/**/*.md'
38+
- title: Upgrading
39+
prefix: /upgrade_guide
40+
sources:
41+
- type: markdown
42+
files: 'upgrade_guide/**/*.md'
43+
- title: FAQ
44+
prefix: /faq
45+
sources:
46+
- type: markdown
47+
files: 'faq/**/*.md'
48+
links:
49+
- title: Code
50+
href: https://github.com/datastax/java-driver/
51+
- title: Docs
52+
href: http://docs.datastax.com/en/developer/java-driver
53+
- title: Issues
54+
href: https://datastax-oss.atlassian.net/browse/JAVA/
55+
- title: Mailing List
56+
href: https://groups.google.com/a/lists.datastax.com/forum/#!forum/java-driver-user
57+
- title: Releases
58+
href: https://github.com/datastax/java-driver/releases
59+
api_docs:
60+
4.0: http://docs.datastax.com/en/drivers/java/4.0

‎faq/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ At any rate, `CompletionStage` has a `toCompletableFuture()` method. In current
6565
### Where is `DowngradingConsistencyRetryPolicy` from driver 3?
6666

6767
**As of driver 4.10, this retry policy was made available again as a built-in alternative to the
68-
default retry policy**: see the [manual](../manual/core/retries) to understand how to use it.
68+
default retry policy**: see the [manual](manual/core/retries/README.md) to understand how to use it.
6969
For versions between 4.0 and 4.9 inclusive, there is no built-in equivalent of driver 3
7070
`DowngradingConsistencyRetryPolicy`.
7171

@@ -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/loadbalancing/README.md) to
104104
understand how to enable this feature; for driver versions < 4.10.0, this feature is simply not
105105
available.
106106

@@ -109,7 +109,7 @@ available.
109109
The driver now uses Java 8's improved date and time API. CQL type `timestamp` is mapped to
110110
`java.time.Instant`, and the corresponding getter and setter are `getInstant` and `setInstant`.
111111

112-
See [Temporal types](../manual/core/temporal_types/) for more details.
112+
See [Temporal types](manual/core/temporal_types/README.md) for more details.
113113

114114
### Why do DDL queries have a higher latency than driver 3?
115115

@@ -119,6 +119,6 @@ noticeably higher latency than driver 3 (about 1 second).
119119
This is because those queries are now *debounced*: the driver adds a short wait in an attempt to
120120
group multiple schema changes into a single metadata refresh. If you want to mitigate this, you can
121121
either adjust the debouncing settings, or group your schema updates while temporarily disabling the
122-
metadata; see the [performance](../manual/core/performance/#debouncing) page.
122+
metadata; see the [performance](manual/core/performance/#debouncing/README.md) page.
123123

124124
This only applies to DDL queries; DML statements (`SELECT`, `INSERT`...) are not debounced.

‎manual/HOME-README.md‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎manual/HOME-README.md‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# Java Driver for Apache Cassandra®
2+
3+
:warning: The java-driver has recently been donated by Datastax to The Apache Software Foundation and the Apache Cassandra project. Bear with us as we move assets and coordinates.
4+
5+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
6+
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.cassandra/java-driver-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.cassandra/java-driver-core)
7+
8+
*If you're reading this on github.com, please note that this is the readme for the development
9+
version and that some features described here might not yet have been released. You can find the
10+
documentation for latest version through [DataStax Docs] or via the release tags, e.g.
11+
[4.17.0](https://github.com/datastax/java-driver/tree/4.17.0).*
12+
13+
A modern, feature-rich and highly tunable Java client library for [Apache Cassandra®] \(2.1+) and
14+
[DataStax Enterprise] \(4.7+), and [DataStax Astra], using exclusively Cassandra's binary protocol
15+
and Cassandra Query Language (CQL) v3.
16+
17+
[DataStax Docs]: http://docs.datastax.com/en/developer/java-driver/
18+
[Apache Cassandra®]: http://cassandra.apache.org/
19+
20+
## Getting the driver
21+
22+
The driver artifacts are published in Maven central, under the group id [com.datastax.oss]; there
23+
are multiple modules, all prefixed with `java-driver-`.
24+
25+
```xml
26+
<dependency>
27+
<groupId>org.apache.cassandra</groupId>
28+
<artifactId>java-driver-core</artifactId>
29+
<version>${driver.version}</version>
30+
</dependency>
31+
32+
<dependency>
33+
<groupId>org.apache.cassandra</groupId>
34+
<artifactId>java-driver-query-builder</artifactId>
35+
<version>${driver.version}</version>
36+
</dependency>
37+
38+
<dependency>
39+
<groupId>org.apache.cassandra</groupId>
40+
<artifactId>java-driver-mapper-runtime</artifactId>
41+
<version>${driver.version}</version>
42+
</dependency>
43+
```
44+
45+
Note that the query builder is now published as a separate artifact, you'll need to add the
46+
dependency if you plan to use it.
47+
48+
Refer to each module's manual for more details ([core](/manual/core/README.md), [query
49+
builder](/manual/query_builder/README.md), [mapper](/manual/mapper/README.md)).
50+
51+
[com.datastax.oss]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.datastax.oss%22
52+
53+
## Compatibility
54+
55+
The driver is compatible with Apache Cassandra® 2.1 and higher, DataStax Enterprise 4.7 and
56+
higher, and DataStax Astra.
57+
58+
It requires Java 8 or higher.
59+
60+
Disclaimer: Some DataStax/DataStax Enterprise products might partially work on big-endian systems,
61+
but DataStax does not officially support these systems.
62+
63+
## Migrating from previous versions
64+
65+
Java Driver 4 is **not binary compatible** with previous versions. However, most of the concepts
66+
remain unchanged, and the new API will look very familiar to 2.x and 3.x users.
67+
68+
See the [upgrade guide](upgrade_guide/README.md) for details.
69+
70+
## Error Handling
71+
72+
See the [Cassandra error handling done right blog](https://www.datastax.com/blog/cassandra-error-handling-done-right) for error handling with the Java Driver for Apache Cassandra&trade;.
73+
74+
## Useful links
75+
76+
* [Manual](/manual/README.md)
77+
* [API docs]
78+
* Bug tracking: [JIRA]
79+
* [Mailing list]
80+
* [Changelog]
81+
* [FAQ]
82+
83+
[API docs]: https://docs.datastax.com/en/drivers/java/4.17
84+
[JIRA]: https://issues.apache.org/jira/issues/?jql=project%20%3D%20CASSJAVA%20ORDER%20BY%20key%20DESC
85+
[Mailing list]: https://groups.google.com/a/lists.datastax.com/forum/#!forum/java-driver-user
86+
[Changelog]: changelog/README.md
87+
[FAQ]: faq/README.md
88+
89+
## License
90+
91+
&copy; The Apache Software Foundation
92+
93+
Licensed under the Apache License, Version 2.0 (the "License");
94+
you may not use this file except in compliance with the License.
95+
You may obtain a copy of the License at
96+
97+
http://www.apache.org/licenses/LICENSE-2.0
98+
99+
Unless required by applicable law or agreed to in writing, software
100+
distributed under the License is distributed on an "AS IS" BASIS,
101+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
102+
See the License for the specific language governing permissions and
103+
limitations under the License.
104+
105+
----
106+
107+
Apache Cassandra, Apache, Tomcat, Lucene, Solr, Hadoop, Spark, TinkerPop, and Cassandra are
108+
trademarks of the [Apache Software Foundation](http://www.apache.org/) or its subsidiaries in
109+
Canada, the United States and/or other countries.
110+
111+
Binary artifacts of this product bundle Java Native Runtime libraries, which is available under the Eclipse Public License version 2.0.

‎manual/README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,16 @@ under the License.
2121

2222
Driver modules:
2323

24-
* [Core](core/): the main entry point, deals with connectivity and query execution.
25-
* [Query builder](query_builder/): a fluent API to create CQL queries programmatically.
26-
* [Mapper](mapper/): generates the boilerplate to execute queries and convert the results into
24+
* [Core](core/README.md): the main entry point, deals with connectivity and query execution.
25+
* [Query builder](query_builder/README.md): a fluent API to create CQL queries programmatically.
26+
* [Mapper](mapper/README.md): generates the boilerplate to execute queries and convert the results into
2727
application-level objects.
28-
* [Developer docs](developer/): explains the codebase and internal extension points for advanced
28+
* [Developer docs](developer/README.md): explains the codebase and internal extension points for advanced
2929
customization.
3030

3131
Common topics:
3232

33-
* [API conventions](api_conventions/)
34-
* [Case sensitivity](case_sensitivity/)
35-
* [OSGi](osgi/)
36-
* [Cloud](cloud/)
33+
* [API conventions](api_conventions/README.md)
34+
* [Case sensitivity](case_sensitivity/README.md)
35+
* [OSGi](osgi/README.md)
36+
* [Cloud](cloud/README.md)

‎manual/cloud/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,5 +146,5 @@ public class Main {
146146
[Create an Astra database - AWS/Azure/GCP]: https://docs.datastax.com/en/astra/docs/creating-your-astra-database.html
147147
[Access an Astra database - AWS/Azure/GCP]: https://docs.datastax.com/en/astra/docs/obtaining-database-credentials.html#_sharing_your_secure_connect_bundle
148148
[Download the secure connect bundle - AWS/Azure/GCP]: https://docs.datastax.com/en/astra/docs/obtaining-database-credentials.html
149-
[minimal project structure]: ../core/integration/#minimal-project-structure
150-
[driver documentation]: ../core/configuration/
149+
[minimal project structure]: ../core/integration/README.md#minimal-project-structure
150+
[driver documentation]: ../core/configuration/README.md

0 commit comments

Comments
 (0)