-
Notifications
You must be signed in to change notification settings - Fork 13
Introduce docs from CPP Driver and adjust #357
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
Open
wprzytula
wants to merge
75
commits into
scylladb:master
Choose a base branch
from
wprzytula:introduce-docs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
75 commits
Select commit
Hold shift + click to select a range
e3fba03
release/redhat: fix typo
wprzytula c6839c5
docs: rename index.rst to contents.rst
wprzytula 944995d
docs: delete the sample page
wprzytula 280a427
conf.py: update site description
wprzytula cd6fd9e
import Doxyfile.in from cpp-driver
wprzytula 0de457e
adjust Doxyfile.in from cpp-driver
wprzytula 3084f52
docs: import topics from cpp-driver
wprzytula f1c05c2
codewide: Scylla -> ScyllaDB
wprzytula 7a9370d
codewide: remove mentions of ancient Cassandras
wprzytula 1d752f0
docs/tracing: fix typos
wprzytula bd78961
docs: delete cloud topic
wprzytula 079149f
docs: remove DSE features documentation
wprzytula ad31cc5
docs: mention only currect default consistency
wprzytula 935e23e
docs: adjust for default client-side timestamps
wprzytula 51527b9
docs: describe default serial consistency
wprzytula 6660d53
docs: describe callbacks limitations on blocking
wprzytula a557f1b
docs: add main index.md
wprzytula 11c9827
docs: add API index.md
wprzytula 344e512
docs: rename Features -> Overview
wprzytula 3480705
docs: extract Observability
wprzytula b2d509b
docs: specify tree structure in `contents.rst`
wprzytula f4f85fd
docs: extract load_balancing
wprzytula 0b25e72
docs: extract speculative_execution
wprzytula 91e8528
docs: retry_policies/README.md -> retry_policies.md
wprzytula d7d52c1
docs: extract performance tips
wprzytula 58d05fa
docs: rename README->index and reduce nesting
wprzytula 3e0e2a4
docs: replace underscores with hyphens
wprzytula e763be7
docs/ssl: fix heading level hierarchy
wprzytula a0e68c2
docs: remove FAQ, as it's empty anyway
wprzytula 4056c2b
docs/configuration: extract connection config
wprzytula 2d8e826
docs/configuration: extract nonsupported options
wprzytula e4fee9f
docs/basics/index.md: fix typo
wprzytula 6f8fe5f
docs/basics: Remove supported versions column
wprzytula c5e18dc
docs: update links to point to ScyllaDB docs
wprzytula 4e06587
docs: remove mentions of Custom types
wprzytula 94da72a
docs/futures: small fixes
wprzytula 01bd261
docs: more considerations on setting keyspace
wprzytula ba4b610
docswide: Cassandra -> ScyllaDB/Cassandra
wprzytula 0b20294
docs/load-balancing: adjust for CPP-Rust
wprzytula 36cc10d
docs/retry-polices: adjust for CPP-Rust
wprzytula 6d141a2
docs: move client-configuration to configuration
wprzytula 7674c5a
docs: move execution-profiles to configuration
wprzytula 435e905
docs/exec_profile: mention SEP as available setting
wprzytula 0aaf654
docs: move shard awareness to load balancing
wprzytula ade3ad0
docs/metrics: adjust for CPP-Rust
wprzytula d2d8184
docs/security: extract nonsupported features
wprzytula f3c7a92
docs/ssl: don't offer DataStax mailing list
wprzytula 7872ddb
docs: SSL -> TLS
wprzytula e1db681
docs/security: extract authentication section
wprzytula 147de60
docs: adjust quickstart code for CPP-Rust Driver
wprzytula 825fbda
docs/overview: fix IO thread description accuracy
wprzytula a954892
docs/overview: remove TODO section
wprzytula 751544a
docs/overview: Update links for cpp-rust-driver
wprzytula 51f918f
docs: remove ccm VM setup documentation
wprzytula 11b504d
docs: extract Getting Started
wprzytula 1328b5b
docs: extract Architecture Overview
wprzytula 5ac06ae
docs/basics: move data types mapping
wprzytula b85430b
docs: client-configuration -> client-identity
wprzytula d6f2e2c
docs/configuration: add table of contents
wprzytula 780584a
docs/basics: group datatypes-related topics
wprzytula 7e8dbac
docs/basic: add table of contents
wprzytula 4c80957
docs: basics -> using the driver
wprzytula ae06e33
docs: fix typos found by Copilot
wprzytula 69e661a
docs/building: remove Windows section
wprzytula 8e60341
docs: remove mentions of zlib dependency
wprzytula dd4695f
build system: remove zlib-related code
wprzytula a579cda
docs: remove mentions of Kerberos dependency
wprzytula c13e482
IT: remove embedded_ads code
wprzytula 3059a1b
build system: remove Kerberos-related code
wprzytula 7da985e
docs/building: modernise libuv mentions
wprzytula 7ac356e
docs: update building & installation instructions
wprzytula 250e4f6
docs: list contents on the front page
wprzytula 1c5f18c
README: update front description
wprzytula 7b77e66
WIP: setup sphinx docs
wprzytula 5aeb383
WIP: URLs: DataStax -> ScyllaDB docs
wprzytula 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
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.
Uh oh!
There was an error while loading. Please reload this page.
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.
Lines 28 and 29 look ok.
We can remove lines 30–32 and set
SOURCEDIR
tosource
.In this project, it does not appear necessary to copy the documentation to a separate
_sources
folder for post-processing. That workflow is only required in projects where files need to be renamed at runtime, such as convertingREADME.md
toindex.md
.