Skip to content

Adding documentation for scylla specific features - #33

Merged
fruch merged 3 commits into
scylladb:masterfrom
fruch:fork_docs
Jun 10, 2020
Merged

Adding documentation for scylla specific features#33
fruch merged 3 commits into
scylladb:masterfrom
fruch:fork_docs

Conversation

@fruch

@fruchfruch commented Jun 10, 2020

Copy link
Copy Markdown
  • 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: #27 and #26

@fruchfruch added the documentation Requires documentation label Jun 10, 2020
@fruch
fruch requested review from lauranovich and tzachJune 10, 2020 06:20
@fruchfruch self-assigned this Jun 10, 2020
* 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

@tzachtzach left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one (very) minor suggestion

Comment threaddocs/scylla_specific.rst Outdated
@fruch
fruch requested a review from ultrabugJune 10, 2020 06:38
@fruch

Copy link
Copy Markdown
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
Comment threaddocs/scylla_specific.rst Outdated
with @lauranovich comment
Co-authored-by: Laura Novich <36125151+lauranovich@users.noreply.github.com>
@fruch
fruch requested review from lauranovich and tzachJune 10, 2020 16:17
Comment threadREADME.rst
* 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>`_

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we use local RST links for all of these?

@fruchfruchJun 10, 2020

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@tzach

Copy link
Copy Markdown

LGTM

We can fix the relative path in a later PR

@fruch
fruch merged commit 9f0fdcc into scylladb:masterJun 10, 2020
@fruch
fruch deleted the fork_docs branch June 10, 2020 18:49
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationRequires documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Doc: Explain what is shard aware driver, why they are better

3 participants

@fruch@tzach@lauranovich