Skip to content

Commit d7236d5

Browse files
committed
Doc tweaks in preparation of 3.0.1 release.
1 parent 3fc2f3d commit d7236d5

File tree

3 files changed

+21
-20
lines changed

3 files changed

+21
-20
lines changed

CHANGELOG.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
# master
2-
Features:
1+
# 3.0.1
32

43
Bug Fixes:
54
* [RUBY-219](https://datastax-oss.atlassian.net/browse/RUBY-219) Sometimes get stack trace in metadata.rb due to failure in SortedSet initialization.

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
# Datastax Ruby Driver for Apache Cassandra
22

3-
*If you're reading this on GitHub, please note that this is the readme for the development version and that some features described here might not yet have been released. You can [find the documentation for latest version through ruby driver docs](http://datastax.github.io/ruby-driver/) or via the release tags, [e.g. v3.0.0](https://github.com/datastax/ruby-driver/tree/v3.0.0).*
3+
*If you're reading this on GitHub, please note that this is the readme for the development version and that some features described here might not yet have been released. You can [find the documentation for the latest version through ruby driver docs](http://docs.datastax.com/en/latest-ruby-driver/ruby-driver/whatsNew.html) or via the release tags, [e.g. v3.0.1](https://github.com/datastax/ruby-driver/tree/v3.0.1).*
44

55
[![Build Status](https://travis-ci.org/datastax/ruby-driver.svg?branch=master)](https://travis-ci.org/datastax/ruby-driver)
66

77
A Ruby client driver for Apache Cassandra. This driver works exclusively with
88
the Cassandra Query Language version 3 (CQL3) and Cassandra's native protocol.
99

1010
- Code: https://github.com/datastax/ruby-driver
11-
- Docs: http://datastax.github.io/ruby-driver/
11+
- Docs: http://docs.datastax.com/en/latest-ruby-driver/ruby-driver/whatsNew.html
1212
- Jira: https://datastax-oss.atlassian.net/browse/RUBY
1313
- Mailing List: https://groups.google.com/a/lists.datastax.com/forum/#!forum/ruby-driver-user
1414
- IRC: #datastax-drivers on [irc.freenode.net](http://freenode.net>)
1515
- Twitter: Follow the latest news about DataStax Drivers - [@avalanche123](http://twitter.com/avalanche123), [@stamhankar999](http://twitter.com/stamhankar999), [@al3xandru](https://twitter.com/al3xandru)
1616

1717
This driver is based on [the cql-rb gem](https://github.com/iconara/cql-rb) by [Theo Hultberg](https://github.com/iconara) and we added support for:
1818

19-
* [Asynchronous execution](http://datastax.github.io/ruby-driver/features/asynchronous_io/)
20-
* One-off, [prepared](http://datastax.github.io/ruby-driver/features/basics/prepared_statements/) and [batch statements](http://datastax.github.io/ruby-driver/features/basics/batch_statements/)
21-
* Automatic peer discovery and cluster metadata with [support for change notifications](http://datastax.github.io/ruby-driver/features/state_listeners/)
22-
* Various [load-balancing](http://datastax.github.io/ruby-driver/features/load_balancing/), [retry](http://datastax.github.io/ruby-driver/features/retry_policies/) and [reconnection](http://datastax.github.io/ruby-driver/features/reconnection/) policies with [ability to write your own](http://datastax.github.io/ruby-driver/features/load_balancing/implementing_a_policy/)
23-
* [SSL encryption](http://datastax.github.io/ruby-driver/features/security/ssl_encryption/)
24-
* [Flexible and robust error handling](http://datastax.github.io/ruby-driver/features/error_handling/)
25-
* [Per-request execution information and tracing](http://datastax.github.io/ruby-driver/features/debugging/)
26-
* [Configurable address resolution](http://datastax.github.io/ruby-driver/features/address_resolution/)
19+
* [Asynchronous execution](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/asynchronous_io/)
20+
* One-off, [prepared](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/basics/prepared_statements/) and [batch statements](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/basics/batch_statements/)
21+
* Automatic peer discovery and cluster metadata with [support for change notifications](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/state_listeners/)
22+
* Various [load-balancing](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/load_balancing/), [retry](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/retry_policies/) and [reconnection](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/reconnection/) policies with [ability to write your own](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/load_balancing/implementing_a_policy/)
23+
* [SSL encryption](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/security/ssl_encryption/)
24+
* [Flexible and robust error handling](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/error_handling/)
25+
* [Per-request execution information and tracing](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/debugging/)
26+
* [Configurable address resolution](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/address_resolution/)
2727

2828
[Check out the slides from Ruby Driver Explained](https://speakerdeck.com/avalanche123/ruby-driver-explained) for a detailed overview of the Ruby Driver architecture.
2929

@@ -67,9 +67,9 @@ __Note__: The host you specify is just a seed node, the driver will automaticall
6767

6868
Read more:
6969

70-
* [`Cassandra.cluster` options](http://datastax.github.io/ruby-driver/api/#cluster-class_method)
71-
* [`Session#execute_async` options](http://datastax.github.io/ruby-driver/api/session/#execute_async-instance_method)
72-
* [Usage documentation](http://datastax.github.io/ruby-driver/features)
70+
* [`Cassandra.cluster` options](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/api/cassandra/#cluster-class_method)
71+
* [`Session#execute_async` options](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/api/cassandra/session/#execute_async-instance_method)
72+
* [Usage documentation](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features)
7373

7474
## Installation
7575

@@ -85,14 +85,16 @@ Install via Gemfile
8585
gem 'cassandra-driver'
8686
```
8787

88-
__Note__: if you want to use compression you should also install [snappy](http://rubygems.org/gems/snappy) or [lz4-ruby](http://rubygems.org/gems/lz4-ruby). [Read more about compression.](http://datastax.github.io/ruby-driver/features/#compression)
88+
__Note__: if you want to use compression you should also install [snappy](http://rubygems.org/gems/snappy) or [lz4-ruby](http://rubygems.org/gems/lz4-ruby). [Read more about compression.](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/#compression)
8989

9090

9191
## Upgrading from cql-rb
9292

9393
Some of the new features added to the driver have unfortunately led to changes in the original cql-rb API. In the examples directory, you can find [an example of how to wrap the ruby driver to achieve almost complete interface parity with cql-rb](https://github.com/datastax/ruby-driver/blob/master/examples/cql-rb-wrapper.rb) to assist you with gradual upgrade.
9494

95-
## What's new in v3.0.0
95+
## What's new in v3.0
96+
97+
See the [changelog](https://github.com/datastax/ruby-driver/blob/master/CHANGELOG.md) for details on patch versions.
9698

9799
### Features:
98100

@@ -210,7 +212,7 @@ the release.
210212
* Because the driver reactor is using `IO.select`, the maximum number of tcp connections allowed is 1024.
211213
* Because the driver uses `IO#write_nonblock`, Windows is not supported.
212214

213-
Please [refer to the usage documentation for more information on common pitfalls](http://datastax.github.io/ruby-driver/features/)
215+
Please [refer to the usage documentation for more information on common pitfalls](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/)
214216

215217
## Contributing
216218

@@ -240,4 +242,4 @@ License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
240242
either express or implied. See the License for the specific language governing permissions
241243
and limitations under the License.
242244

243-
[1]: http://datastax.github.io/ruby-driver/api
245+
[1]: http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/api

features/reconnection/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Reconnection
22

3-
Ruby driver will automatically reestablish failed connections to Cassandra nodes. It uses reconnection policy to determine retry intervals for reconnection.
3+
Ruby driver will automatically reestablish failed connections to Cassandra nodes. It uses a reconnection policy to determine retry intervals for reconnection.

0 commit comments

Comments
 (0)