Adding documentation for scylla specific features - #33
Merged
Conversation
* new page `docs/scylla_specific.rst` documenting shared aware and in_memory table attribute * added it the TOC * reference it from the README.rst Fixes: scylladb#27 and scylladb#26
Author
|
@ultrabug do you think we need more things in the shared aware part ? |
Co-authored-by: Tzach Livyatan <tzach.livyatan@gmail.com>
dgarcia360
pushed a commit
to dgarcia360/python-driver
that referenced
this pull request
Jun 10, 2020
Merge ossnext ngdg
lauranovich
reviewed
Jun 10, 2020
with @lauranovich comment Co-authored-by: Laura Novich <36125151+lauranovich@users.noreply.github.com>
tzach
reviewed
Jun 10, 2020
| * Configurable `load balancing <http://scylladb.github.io/python-driver/api/cassandra/policies.html#load-balancing>`_ and `retry policies <http://scylladb.github.io/python-driver/api/cassandra/policies.html#retrying-failed-operations>`_ | ||
| * `Concurrent execution utilities <http://scylladb.github.io/python-driver/api/cassandra/concurrent.html>`_ | ||
| * `Object mapper <http://scylladb.github.io/python-driver/object_mapper.html>`_ | ||
| * `Shard awareness <http://scylladb.github.io/python-driver/scylla_specific.html#shard-awareness>`_ |
There was a problem hiding this comment.
Can we use local RST links for all of these?
Author
There was a problem hiding this comment.
No, since they are for links from GitHub readme preview.
The readme.rst isn't part of the docs
If it would be relative, it would point to the raw .rst files, with no themes and other shpinx plugins
|
LGTM We can fix the relative path in a later PR |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
docs/scylla_specific.rstdocumenting shared aware and in_memory table attributeFixes: #27 and #26