Skip to content

Commit f81cba4

Browse files
authored
Documentation cleanup (#579)
1 parent d9ae6b9 commit f81cba4

File tree

21 files changed

+88
-88
lines changed

21 files changed

+88
-88
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,6 @@ submit them in a new commit. These commits will be squashed before inclusion
131131
into the stable or unstable branches.
132132

133133
[JIRA]: https://datastax-oss.atlassian.net/browse/CPP/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel
134-
[Google C++ Style Guide]: http://google-styleguide.googlecode.com/svn/trunk/cppguide.html
134+
[Google C++ Style Guide]: https://google.github.io/styleguide/cppguide.html
135135
[early exits]: http://llvm.org/docs/CodingStandards.html#use-early-exits-and-continue-to-simplify-code
136-
[testing guide]: http://datastax.github.io/cpp-driver/topics/testing
136+
[testing guide]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/testing

README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -236,30 +236,30 @@ specific language governing permissions and limitations under the License.
236236
[DataStax Astra]: https://astra.datastax.com
237237
[Kerberos]: https://web.mit.edu/kerberos
238238
239-
[Asynchronous API]: http://datastax.github.io/cpp-driver/topics/#futures
240-
[Simple]: http://datastax.github.io/cpp-driver/topics/#executing-queries
241-
[Prepared]: http://datastax.github.io/cpp-driver/topics/basics/prepared_statements/
242-
[Batch]: http://datastax.github.io/cpp-driver/topics/basics/batches/
243-
[Asynchronous I/O]: http://datastax.github.io/cpp-driver/topics/#asynchronous-i-o
244-
[parallel execution]: http://datastax.github.io/cpp-driver/topics/#thread-safety
245-
[load balancing]: http://datastax.github.io/cpp-driver/topics/configuration/#load-balancing
246-
[Authentication]: http://datastax.github.io/cpp-driver/topics/security/#authentication
247-
[SSL]: http://datastax.github.io/cpp-driver/topics/security/ssl/
248-
[Latency-aware routing]: http://datastax.github.io/cpp-driver/topics/configuration/#latency-aware-routing
249-
[Performance metrics]: http://datastax.github.io/cpp-driver/topics/metrics/
250-
[Tuples]: http://datastax.github.io/cpp-driver/topics/basics/tuples/
251-
[UDTs]: http://datastax.github.io/cpp-driver/topics/basics/user_defined_types/
252-
[Nested collections]: http://datastax.github.io/cpp-driver/topics/basics/binding_parameters/#nested-collections
253-
[Data types]: http://datastax.github.io/cpp-driver/topics/basics/data_types/
254-
[Retry policies]: http://datastax.github.io/cpp-driver/topics/configuration/retry_policies/
255-
[Client-side timestamps]: http://datastax.github.io/cpp-driver/topics/basics/client_side_timestamps/
256-
[Idle connection heartbeats]: http://datastax.github.io/cpp-driver/topics/configuration/#connection-heartbeats
257-
[Blacklist]: http://datastax.github.io/cpp-driver/topics/configuration/#blacklist
258-
[whitelist DC]: http://datastax.github.io/cpp-driver/topics/configuration/#datacenter
259-
[blacklist DC]: http://datastax.github.io/cpp-driver/topics/configuration/#datacenter
260-
[Custom]: http://datastax.github.io/cpp-driver/topics/security/#custom
261-
[Reverse DNS]: http://datastax.github.io/cpp-driver/topics/security/ssl/#enabling-cassandra-identity-verification
262-
[Speculative execution]: http://datastax.github.io/cpp-driver/topics/configuration/#speculative-execution
239+
[Asynchronous API]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/#futures
240+
[Simple]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/#executing-queries
241+
[Prepared]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/basics/prepared_statements/
242+
[Batch]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/basics/batches/
243+
[Asynchronous I/O]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/#asynchronous-i-o
244+
[parallel execution]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/#thread-safety
245+
[load balancing]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/configuration/#load-balancing
246+
[Authentication]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/security/#authentication
247+
[SSL]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/security/ssl/
248+
[Latency-aware routing]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/configuration/#latency-aware-routing
249+
[Performance metrics]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/metrics/
250+
[Tuples]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/basics/tuples/
251+
[UDTs]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/basics/user_defined_types/
252+
[Nested collections]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/basics/binding_parameters/#nested-collections
253+
[Data types]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/basics/data_types/
254+
[Retry policies]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/configuration/retry_policies/
255+
[Client-side timestamps]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/basics/client_side_timestamps/
256+
[Idle connection heartbeats]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/configuration/#connection-heartbeats
257+
[Blacklist]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/configuration/#blacklist
258+
[whitelist DC]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/configuration/#datacenter
259+
[blacklist DC]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/configuration/#datacenter
260+
[Custom]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/security/#custom
261+
[Reverse DNS]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/security/ssl/#enabling-cassandra-identity-verification
262+
[Speculative execution]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/configuration/#speculative-execution
263263
[DSE authentication]: http://docs.datastax.com/en/developer/cpp-driver/latest/dse_features/authentication
264264
[DSE geospatial types]: http://docs.datastax.com/en/developer/cpp-driver/latest/dse_features/geotypes
265265
[DSE Proxy Authentication]: http://docs.datastax.com/en/developer/cpp-driver/latest/dse_features/authentication/#proxy-authentication

docs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ nanoc_config:
3939
- '^https?://ci.appveyor.com/*'
4040
- 'https://twitter.com/datastax'
4141
rewrites:
42-
- http://datastax.github.io/cpp-driver/: /
42+
- https://docs.datastax.com/en/developer/cpp-driver/latest/: /
4343
- https://datastax.github.io/cpp-driver/: /
4444
# Compatability changes for older versions
4545
- /api/Cass(.*): /api/struct.Cass\1

packaging/debian/control

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Build-Depends: debhelper (>= 9.0.0), dh-exec, cmake, make,
66
libssl-dev
77
Standards-Version: 3.9.2
88
Section: libs
9-
Homepage: http://datastax.github.io/cpp-driver/
9+
Homepage: https://docs.datastax.com/en/developer/cpp-driver/latest/
1010
Vcs-Git: git://github.com/datastax/cpp-driver.git
1111
Vcs-Browser: https://github.com/datastax/cpp-driver
1212

packaging/homebrew/cassandra-cpp-driver.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
require "formula"
22

33
class CassandraCppDriver < Formula
4-
homepage "http://datastax.github.io/cpp-driver/"
4+
homepage "https://docs.datastax.com/en/developer/cpp-driver/latest/"
55
url "https://github.com/datastax/cpp-driver/archive/2.7.0.tar.gz"
66
sha256 "44a97679e719b2b046ef90323beab4fe3a491ae79396e7f28e6a9677b618a0e4"
77
version "2.7.0"

topics/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -253,15 +253,15 @@ with other drivers. The schedule for these features can be found on [JIRA].
253253
- Callback interfaces for load balancing, authentication, reconnection and retry
254254
255255
[Artifactory server]: https://datastax.jfrog.io/artifactory/cpp-php-drivers/cpp-driver/builds
256-
[built from source]: http://datastax.github.io/cpp-driver/topics/building/
257-
[prepared statements]: http://datastax.github.io/cpp-driver/topics/basics/prepared_statements/
258-
[`cass_int32_t`]: http://datastax.github.io/cpp-driver/api/cassandra.h/#cass-int32-t
259-
[`cass_result_first_row()`]: http://datastax.github.io/cpp-driver/api/struct.CassResult/#cass-result-first-row
260-
[`cass_cluster_set_num_threads_io()`]: http://datastax.github.io/cpp-driver/api/struct.CassCluster/#function-cass_cluster_set_num_threads_io
261-
[`CassCluster`]: http://datastax.github.io/cpp-driver/api/struct.CassCluster/
262-
[`CassFuture`]: http://datastax.github.io/cpp-driver/api/struct.CassFuture/
263-
[`CassStatement`]: http://datastax.github.io/cpp-driver/api/struct.CassStatement/
264-
[`CassIterator`]: http://datastax.github.io/cpp-driver/api/struct.CassIterator/
265-
[`CassSession`]: http://datastax.github.io/cpp-driver/api/struct.CassSession/
256+
[built from source]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/building/
257+
[prepared statements]: https://docs.datastax.com/en/developer/cpp-driver/latest/topics/basics/prepared_statements/
258+
[`cass_int32_t`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/cassandra.h/#cass-int32-t
259+
[`cass_result_first_row()`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassResult/#cass-result-first-row
260+
[`cass_cluster_set_num_threads_io()`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassCluster/#function-cass_cluster_set_num_threads_io
261+
[`CassCluster`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassCluster/
262+
[`CassFuture`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassFuture/
263+
[`CassStatement`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassStatement/
264+
[`CassIterator`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassIterator/
265+
[`CassSession`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassSession/
266266
[post]: http://www.datastax.com/dev/blog/4-simple-rules-when-using-the-datastax-drivers-for-cassandra
267267
[JIRA]: https://datastax-oss.atlassian.net/browse/CPP

topics/basics/binding_parameters/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ resize) a statement's parameters.
3939

4040
## Constructing Collections
4141

42-
Collections are supported using [`CassCollection`](http://datastax.github.io/cpp-driver/api/struct.CassCollection/) objects; supporting `list`, `map` and `set` Cassandra types. The code below shows how to construct a `list` collection; however, a set can be constructed in a very similar way. The only difference is the type `CASS_COLLECTION_TYPE_SET` is used to create the collection instead of `CASS_COLLECTION_TYPE_LIST`.
42+
Collections are supported using [`CassCollection`](https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassCollection/) objects; supporting `list`, `map` and `set` Cassandra types. The code below shows how to construct a `list` collection; however, a set can be constructed in a very similar way. The only difference is the type `CASS_COLLECTION_TYPE_SET` is used to create the collection instead of `CASS_COLLECTION_TYPE_LIST`.
4343

4444
**Important**: Values appended to the collection can be freed immediately afterward because the values are copied.
4545

@@ -95,4 +95,4 @@ Custom types can be bound using either the `cass_statement_bind_bytes[_by_name](
9595
name of the custom type matches the class name of the type being bound.
9696

9797
[`cass_collection_append_collection()`]:
98-
http://datastax.github.io/cpp-driver/api/struct.CassCollection/#cass-collection-append-collection
98+
https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassCollection/#cass-collection-append-collection

topics/basics/client_side_timestamps/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,5 +63,5 @@ cass_batch_set_timestamp(batch, 123456789);
6363
/* Add statments to batch */
6464
```
6565
66-
[`CassStatement`]: http://datastax.github.io/cpp-driver/api/struct.CassStatement/
67-
[`CassBatch`]: http://datastax.github.io/cpp-driver/api/struct.CassBatch/
66+
[`CassStatement`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassStatement/
67+
[`CassBatch`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassBatch/

topics/basics/consistency/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ level can be found
8181

8282
## Setting Consistency Level
8383

84-
A ['CassStatement'](http://datastax.github.io/cpp-driver/api/struct.CassFuture/) object
84+
A ['CassStatement'](https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassFuture/) object
8585
can have its consistency level altered at anytime before the statement is
8686
executed by the session.
8787

topics/basics/data_types/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -132,13 +132,13 @@ cass_tuple_free(address);
132132
cass_collection_free(phone_numbers);
133133
```
134134
135-
[`CassDataType`]: http://datastax.github.io/cpp-driver/api/struct.CassDataType/
136-
[`CassUserType`]: http://datastax.github.io/cpp-driver/api/struct.CassUserType/
137-
[`CassPrepared`]: http://datastax.github.io/cpp-driver/api/struct.CassPrepared/
138-
[`CassResult`]: http://datastax.github.io/cpp-driver/api/struct.CassResult/
139-
[`CassValue`]: http://datastax.github.io/cpp-driver/api/struct.CassValue/
140-
[`CassSchemaMeta`]: http://datastax.github.io/cpp-driver/api/struct.CassSchemaMeta/
141-
[`cass_user_type_new_from_data_type()`]: http://datastax.github.io/cpp-driver/api/struct.CassUserType/#cass-user-type-new-from-data-type
142-
[`cass_result_column_data_type()`]: http://datastax.github.io/cpp-driver/api/struct.CassResult/#cass-result-column-data-type
143-
[`cass_prepared_parameter_data_type()`]: http://datastax.github.io/cpp-driver/api/struct.CassPrepared/#cass-prepared-parameter-data-type
144-
[`cass_value_data_type()`]: http://datastax.github.io/cpp-driver/api/struct.CassValue/#cass-value-data-type
135+
[`CassDataType`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassDataType/
136+
[`CassUserType`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassUserType/
137+
[`CassPrepared`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassPrepared/
138+
[`CassResult`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassResult/
139+
[`CassValue`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassValue/
140+
[`CassSchemaMeta`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassSchemaMeta/
141+
[`cass_user_type_new_from_data_type()`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassUserType/#cass-user-type-new-from-data-type
142+
[`cass_result_column_data_type()`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassResult/#cass-result-column-data-type
143+
[`cass_prepared_parameter_data_type()`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassPrepared/#cass-prepared-parameter-data-type
144+
[`cass_value_data_type()`]: https://docs.datastax.com/en/developer/cpp-driver/latest/api/struct.CassValue/#cass-value-data-type

0 commit comments

Comments
 (0)