Skip to content

Commit fd59517

Browse files
olim7tolim7t
committed
Rename 'features' to 'manual'.
1 parent c776e9c commit fd59517

22 files changed

Lines changed: 19 additions & 11 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ docs](http://datastax.github.io/java-driver/) or via the release tags,
1010
[e.g.
1111
2.1.9](https://github.com/datastax/java-driver/tree/2.1.9).*
1212

13-
A modern, [feature-rich](features/) and highly tunable Java client
13+
A modern, [feature-rich](manual/) and highly tunable Java client
1414
library for Apache Cassandra (1.2+) and DataStax Enterprise (3.1+) using
1515
exclusively Cassandra's binary protocol and Cassandra Query Language v3.
1616

@@ -33,7 +33,7 @@ exclusively Cassandra's binary protocol and Cassandra Query Language v3.
3333
[simple_st]: http://docs.datastax.com/en/drivers/java/2.1/com/datastax/driver/core/SimpleStatement.html
3434
[prepared_st]: http://docs.datastax.com/en/drivers/java/2.1/com/datastax/driver/core/Session.html#prepare(com.datastax.driver.core.RegularStatement)
3535
[batch_st]: http://docs.datastax.com/en/drivers/java/2.1/com/datastax/driver/core/BatchStatement.html
36-
[pool]: features/pooling/
36+
[pool]: manual/pooling/
3737
[lbp]: http://docs.datastax.com/en/drivers/java/2.1/com/datastax/driver/core/policies/LoadBalancingPolicy.html
3838
[retry_policy]: http://docs.datastax.com/en/drivers/java/2.1/com/datastax/driver/core/policies/RetryPolicy.html
3939
[query_builder]: http://docs.datastax.com/en/drivers/java/2.1/com/datastax/driver/core/querybuilder/QueryBuilder.html
@@ -62,7 +62,7 @@ The driver contains the following modules:
6262
other drivers, Cassandra, and DSE.
6363
- DOCS: the [user guide](http://docs.datastax.com/en/developer/java-driver/2.1/java-driver/whatsNew2.html)
6464
has introductory material. We are progressively migrating the doc
65-
[here](features/) with more technical details.
65+
[here](manual/) with more technical details.
6666
- API: http://www.datastax.com/drivers/java/2.1
6767

6868
**Feeback requested:** help us focus our efforts, provide your input on the [Platform and Runtime Survey](http://goo.gl/forms/qwUE6qnL7U) (we kept it short).
@@ -91,7 +91,7 @@ Note that the object mapper is published as a separate artifact:
9191
</dependency>
9292
```
9393

94-
We also provide a [shaded JAR](features/shaded_jar/)
94+
We also provide a [shaded JAR](manual/shaded_jar/)
9595
to avoid the explicit dependency to Netty.
9696

9797
If you can't use a dependency management tool, a
@@ -101,7 +101,7 @@ is available for download.
101101
## Compatibility
102102

103103
The Java client driver 2.1 ([branch 2.1](https://github.com/datastax/java-driver/tree/2.1)) is compatible with Apache
104-
Cassandra 1.2, 2.0, 2.1 and 2.2 (see [this page](http://datastax.github.io/java-driver/features/native_protocol) for
104+
Cassandra 1.2, 2.0, 2.1 and 2.2 (see [this page](http://datastax.github.io/java-driver/manual/native_protocol) for
105105
the most up-to-date compatibility information).
106106

107107
UDT and tuple support is available only when using Apache Cassandra 2.1 or higher (see [CQL improvements in Cassandra 2.1](http://www.datastax.com/dev/blog/cql-in-2-1)).

‎docs.yaml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ summary: High performance Java client for Apache Cassandra
55
homepage: http://datastax.github.io/java-driver/
66
theme: datastax
77
sections:
8+
- title: Manual
9+
prefix: /manual
10+
sources:
11+
- type: markdown
12+
files: 'manual/**/*.md'
13+
# The 'manual' section was called 'features' in older releases. Leave both
14+
# definitions and Documentor will pick up whichever exists and ignore the
15+
# other.
816
- title: Features
917
prefix: /features
1018
sources:

‎faq/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
### How do I implement paging?
44

5-
When using [native protocol](../features/native_protocol/) version 2 or
5+
When using [native protocol](../manual/native_protocol/) version 2 or
66
higher, the driver automatically pages large result sets under the hood.
77
You can also save the paging state to resume iteration later. See [this
8-
page](../features/paging/) for more information.
8+
page](../manual/paging/) for more information.
99

1010
Native protocol v1 does not support paging, but you can emulate it in
1111
CQL with `LIMIT` and the `token()` function. See

features/README.md renamed to manual/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
## Features
1+
## Manual
22

33
This part of the documentation is organized into sub-sections covering
44
specific topics.
55

66
If you're reading this from the [generated HTML documentation on
77
github.io](http://datastax.github.io/java-driver/), use the "Read More"
88
menu on the right hand side. If you're [browsing the source files on
9-
github.com](https://github.com/datastax/java-driver/tree/2.1/features),
9+
github.com](https://github.com/datastax/java-driver/tree/2.1/manual),
1010
simply navigate to each sub-directory.
1111

1212
This is a work in progress: new sections will be added to cover existing

features/address_resolution/README.md renamed to manual/address_resolution/README.md

File renamed without changes.

features/async/README.md renamed to manual/async/README.md

File renamed without changes.

features/compression/README.md renamed to manual/compression/README.md

File renamed without changes.

features/logging/README.md renamed to manual/logging/README.md

File renamed without changes.

features/metadata/README.md renamed to manual/metadata/README.md

File renamed without changes.

features/native_protocol/README.md renamed to manual/native_protocol/README.md

File renamed without changes.

0 commit comments

Comments
 (0)