-
Notifications
You must be signed in to change notification settings - Fork 292
2 17 0 doc updates #552
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
2 17 0 doc updates #552
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
1808ed9
Initial cut at README fixes, lots more to do yet
f4be370
Removing explicit EOL versions of MS Studio from AppVeyor config
0421c29
Initial update to gcc versions
9206a01
Change how we represent platforms we test on
6c162d0
Merge branch 'master' into 2_17_0_doc_updates
f5c4d99
Update version to 2.17.0 outright
48ee105
Bringing in Artifactory auth changes from PR #541.
bd4f1f7
CPP-959 Update README to explicitly reference Artifactory rather than…
2010eb1
Changelog updates
f89ee06
README updates
4b72c02
Update building docs
e560872
Missed Windows version string in building doc
510e85c
Fix up installation page (with a few minor fixes to building page as …
50d1489
Add ticket around platform update
68e65e6
Add cmake deprecation warnings ticket to changelog
710a1d3
Update from code review
8fd0550
Update AppVeyor configs to use new creds
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,22 +10,28 @@ products: | |
|
|
||
| ## Getting the Driver | ||
|
|
||
| Binary versions of the driver, available for multiple operating systems and | ||
| multiple architectures, can be obtained from our [download server]. The | ||
| source code is made available via [GitHub]. | ||
|
|
||
| Packages for the driver's dependencies, libuv (1.x), OpenSSL, and zlib are also | ||
| provided under the `dependencies` directory for each platform (if applicable). | ||
| __Note__: CentOS and Ubuntu use the version of OpenSSL and zlib provided with the | ||
| distribution: | ||
|
|
||
| * [CentOS 6][centos-6-dependencies] | ||
| * [CentOS 7][centos-7-dependencies] | ||
| * [CentOS 8][centos-8-dependencies] | ||
| * [Ubuntu 14.04][ubuntu-14-04-dependencies] | ||
| * [Ubuntu 16.04][ubuntu-16-04-dependencies] | ||
| * [Ubuntu 18.04][ubuntu-18-04-dependencies] | ||
| * [Windows][windows-dependencies] | ||
| The source code is made available via [GitHub]. Additionally binary versions of | ||
| the driver (for multiple operating systems and multiple architectures) can be | ||
| obtained from our [Artifactory server]. Binaries are available for the following | ||
| operating systems: | ||
|
|
||
| * CentOS 7 | ||
| * Rocky Linux 8.8 | ||
| * Rocky Linux 9.2 | ||
| * Ubuntu 20.04 | ||
| * Ubuntu 22.04 | ||
| * Windows | ||
|
|
||
| The driver depends on the following libraries: | ||
|
|
||
| * libuv (1.x) | ||
| * OpenSSL | ||
| * zlib | ||
|
|
||
| The version of OpenSSL and zlib provided with each Linux distribution above can be used | ||
| to build the driver. A version of libuv > 1.x is provided for CentOS 7 and Rocky | ||
| Linux; this can be found under the `dependencies` directory for each platform. | ||
| Packages for all three dependencies are provided for Windows distributions. | ||
|
|
||
| ## Upgrading | ||
|
|
||
|
|
@@ -41,7 +47,7 @@ Linking changes will be required when migrating to this driver. Replace `-ldse` | |
|
|
||
| No changes will be required when upgrading to this driver. There will be new | ||
| driver dependencies when using any of the binary versions obtained from our | ||
| [download server] as [Kerberos] is utilized in the [DSE features] of this | ||
| [Artifactory server] as [Kerberos] is utilized in the [DSE features] of this | ||
| driver. See the [installation] section for more information on obtaining the | ||
| dependencies for a specific platform. | ||
|
|
||
|
|
@@ -85,11 +91,22 @@ dependencies for a specific platform. | |
| ## Compatibility | ||
|
|
||
| This driver works exclusively with the Cassandra Query Language v3 (CQL3) and | ||
| Cassandra's native protocol. The current version works with: | ||
| Cassandra's native protocol. The current version works with the following | ||
| server versions: | ||
|
|
||
| * Apache Cassandra® versions 3.0.x, 3.11.x and 4.0.x | ||
| * DSE versions 6.8.x and 5.1.x | ||
|
|
||
| Both 32-bit (x86) and 64-bit (x64) architectures are supported | ||
|
|
||
| We build and test the driver on the following platforms: | ||
|
|
||
| * Apache Cassandra® versions 2.1, 2.2 and 3.0+ | ||
| * Architectures: 32-bit (x86) and 64-bit (x64) | ||
| * Compilers: GCC 4.1.2+, Clang 3.4+, and MSVC 2010/2012/2013/2015/2017/2019 | ||
| * CentOS 7 w/ gcc 4.8.5 | ||
| * Rocky Linux 8.8 w/ gcc 8.5.0 | ||
| * Rocky Linux 9.2 w/ gcc 11.3.1 | ||
| * Ubuntu 20.04 w/ gcc 9.4.0 | ||
| * Ubuntu 22.04 w/ gcc 11.3.0 | ||
| * Microsoft Visual Studio 2013, 2015, 2017 and 2019 | ||
|
|
||
| A complete compatibility matrix for both Apache Cassandra® | ||
| and DataStax Enterprise can be found [here][cpp-driver-compatability-matrix]. | ||
|
|
@@ -105,8 +122,8 @@ __Disclaimer__: DataStax products do not support big-endian systems. | |
|
|
||
| ## Getting Help | ||
|
|
||
| * JIRA: https://datastax-oss.atlassian.net/browse/CPP | ||
| * Mailing List: https://groups.google.com/a/lists.datastax.com/forum/#!forum/cpp-driver-user | ||
| * JIRA: [jira] | ||
| * Mailing List: [mailing list] | ||
|
|
||
| ## Examples | ||
|
|
||
|
|
@@ -207,20 +224,15 @@ specific language governing permissions and limitations under the License. | |
| [Apache Cassandra®]: http://cassandra.apache.org | ||
| [DataStax Enterprise]: http://www.datastax.com/products/datastax-enterprise | ||
| [Examples]: examples/ | ||
| [download server]: http://downloads.datastax.com/cpp-driver/ | ||
| [Artifactory server]: https://datastax.jfrog.io/artifactory/cpp-php-drivers/cpp-driver/builds | ||
| [GitHub]: https://github.com/datastax/cpp-driver | ||
| [cpp-driver-compatability-matrix]: https://docs.datastax.com/en/developer/driver-matrix/doc/cppDrivers.html#cpp-drivers | ||
| [cpp-driver-compatability-matrix]: https://docs.datastax.com/en/driver-matrix/docs/cpp-drivers.html | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Link which needed to be updated in light of the site rework |
||
| [Home]: http://docs.datastax.com/en/developer/cpp-driver/latest | ||
| [API]: http://docs.datastax.com/en/developer/cpp-driver/latest/api | ||
| [Getting Started]: http://docs.datastax.com/en/developer/cpp-driver/latest/topics | ||
| [Building]: http://docs.datastax.com/en/developer/cpp-driver/latest/topics/building | ||
| [centos-6-dependencies]: http://downloads.datastax.com/cpp-driver/centos/6/dependencies | ||
| [centos-7-dependencies]: http://downloads.datastax.com/cpp-driver/centos/7/dependencies | ||
| [centos-8-dependencies]: http://downloads.datastax.com/cpp-driver/centos/8/dependencies | ||
| [ubuntu-14-04-dependencies]: http://downloads.datastax.com/cpp-driver/ubuntu/14.04/dependencies | ||
| [ubuntu-16-04-dependencies]: http://downloads.datastax.com/cpp-driver/ubuntu/16.04/dependencies | ||
| [ubuntu-18-04-dependencies]: http://downloads.datastax.com/cpp-driver/ubuntu/18.04/dependencies | ||
| [windows-dependencies]: http://downloads.datastax.com/cpp-driver/windows/dependencies | ||
| [jira]: https://datastax-oss.atlassian.net/browse/CPP | ||
| [mailing list]: https://groups.google.com/a/lists.datastax.com/forum/#!forum/cpp-driver-user | ||
| [DataStax Astra]: https://astra.datastax.com | ||
| [Kerberos]: https://web.mit.edu/kerberos | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Re-worked this section (and removed the links) since there is no common location in Artifactory that can be used as an entry point for dependencies. We can point users at the "builds" directory but underneath there we have subdirectories for version number and build number.. so it seemed better to provide guidance on how to find the deps rather than try to come up with some arbitrary URL scheme to point at them.