ff90a77f5b
Demote --scylla-data-dir and --scylla-yaml-file to schema source helpers, rather than schema source in themselves. This practically means that when these options are used, they won't define where the tool will attempt to load the schema from, they will just be helpers to help locate the schema, for whichever schema source the tool was instructed to use (or left to choose). --scylla-data-dir and --scylla-yaml-file being schema sources were problematic with encryption at rest and for S3 support (not yet implemented). With encryption, the tool needs access to the configuration, so --scylla-yaml-file is often used to provide the path to the configuration file, which contains encryption configuration, needed for the tool to decrypt the sstable. Currently, using this option implies forcing the tool to read the schema from the schema tables, which is a problematic option for tests -- Scylla might be compacting a schema sstable and this will make the tool fail to load the schema. Demoting these options the schema helpers, allows providing them, while at the same time having the option to use a different schema-source. To allow the user to force the tool to load the schema from the schema tables, a new --schema-tables option is added. Similarly, a --sstable-schema option is introduced to force the tool to load the schema from the sstable itself. With this, each 4 schema source now has an option to force the use of said schema source. There are various helper options to be used along with these. The documentation as well as the tests are updated with the changes. The schema related documentation gets an rather extensive facelift because it was a bit out-of-date and incomplete. Fixes: scylladb/scylladb#20534 Closes scylladb/scylladb#21678
ScyllaDB Documentation
This repository contains the source files for ScyllaDB Open Source documentation.
- The
devfolder contains developer-oriented documentation related to the ScyllaDB code base. It is not published and is only available via GitHub. - All other folders and files contain user-oriented documentation related to ScyllaDB Open Source and are sources for opensource.docs.scylladb.com.
To report a documentation bug or suggest an improvement, open an issue in GitHub issues for this project.
To contribute to the documentation, open a GitHub pull request.
Key Guidelines for Contributors
- The user documentation is written in reStructuredText (RST) - a plaintext markup language similar to Markdown. If you're not familiar with RST, see ScyllaDB RST Examples.
- The developer documentation is written in Markdown. See Basic Markdown Syntax for reference.
- Follow the ScyllaDB Style Guide.
To prevent the build from failing:
-
If you add a new file, ensure it's added to an appropriate toctree, for example:
.. toctree:: :maxdepth: 2 :hidden: Page X </folder1/article1> Page Y </folder1/article2> Your New Page </folder1/your-new-article> -
Make sure the link syntax is correct. See the guidelines on creating links
-
Make sure the section headings are correct. See the guidelines on creating headings Note that the markup must be at least as long as the text in the heading. For example:
---------------------- Prerequisites ----------------------
Building User Documentation
Prerequisites
- Python
- poetry
- make
See the ScyllaDB Sphinx Theme prerequisites to check which versions of the above are currently required.
Mac OS X
You must have a working Homebrew in order to install the needed tools.
You also need the standard utility make.
Check if you have these two items with the following commands:
brew help
make -h
Linux Distributions
Building the user docs should work out of the box on most Linux distributions.
Windows
Use "Bash on Ubuntu on Windows" for the same tools and capabilities as on Linux distributions.
Building the Docs
- Run
make previewto build the documentation. - Preview the built documentation locally at http://127.0.0.1:5500/.
Cleanup
You can clean up all the build products and auto-installed Python stuff with:
make pristine
Information for Contributors
If you are interested in contributing to Scylla docs, please read the Scylla open source page at http://www.scylladb.com/opensource/ and complete a Scylla contributor agreement if needed. We can only accept documentation pull requests if we have a contributor agreement on file for you.
Third-party Documentation
-
Do any copying as a separate commit. Always commit an unmodified version first and then do any editing in a separate commit.
-
We already have a copy of the Apache license in our tree, so you do not need to commit a copy of the license.
-
Include the copyright header from the source file in the edited version. If you are copying an Apache Cassandra document with no copyright header, use:
This document includes material from Apache Cassandra.
Apache Cassandra is Copyright 2009-2014 The Apache Software Foundation.