Skip to content

Commit f087b35

Browse files
committed
refactor to one folder mkdocs, full of symlinks. works well.
1 parent 74b5df2 commit f087b35

File tree

20 files changed

+151
-1397
lines changed

20 files changed

+151
-1397
lines changed

README.md

Lines changed: 3 additions & 3 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/README.md), [query
49-
builder](/manual/query_builder/README.md), [mapper](/manual/mapper/README.md)).
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

@@ -73,7 +73,7 @@ See the [Cassandra error handling done right blog](https://www.datastax.com/blog
7373

7474
## Useful links
7575

76-
* [Manual](/manual/README.md)
76+
* [Manual](manual/README.md)
7777
* [API docs]
7878
* Bug tracking: [JIRA]
7979
* [Mailing list]

build-doc.sh

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,5 @@ 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-
2315
# Build manual with API references
2416
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

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/README.md) 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/README.md) to
103+
If you are using a driver version >= 4.10.0, read the [manual](../manual//core/load_balancing/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/README.md) 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/README.md) page.
122+
metadata; see the [performance](../manual//core/performance/README.md#debouncing) page.
123123

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

manual/HOME-README.md

Lines changed: 0 additions & 111 deletions
This file was deleted.

manual/changelog-README.md

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

manual/core/configuration/reference.conf

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

manual/core/configuration/reference/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,6 @@ values for all configuration options (in the sources, it can be found under
2727
See the [configuration](../README.md) page for more explanations.
2828

2929
```conf
30-
{% include 'core/configuration/reference.conf' %}
30+
{% include 'manual/core/configuration/reference/reference.conf' %}
3131
```
3232

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../../core/src/main/resources/reference.conf

manual/core/reactive/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,7 @@ more fine-grained control of what should be retried, and how, is required.
400400
[ReactiveRow.wasApplied]: https://docs.datastax.com/en/drivers/java/4.17/com/datastax/dse/driver/api/core/cql/reactive/ReactiveRow.html#wasApplied--
401401

402402
[built-in retry mechanism]: ../retries/README.md
403-
[request throttling]: ../throttling/
403+
[request throttling]: ../throttling/README.md
404404

405405
[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

manual/faq-README.md

Lines changed: 0 additions & 124 deletions
This file was deleted.

0 commit comments

Comments
 (0)