The dev folder 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 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

Follow the ScyllaDB Style Guide.
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.

Submitting a KB Article

If you are submitting a knowledgebase article (KB), use the following guidelines:

In the /kb_common directory, there is a template for KBs. It is called kb-article-template.rst.
Make a copy of the KB template in the /kb directory and rename it with a unique name.
Open the new file and fill in the required information.
Remove what is not needed.
Run make preview to build the docs and preview them locally.
Send a PR with "KB" in its title.

Building User Documentation

Prerequisites

Python 3. Check your version with $ python --version
Vale CLI (optional to lint docs). Install Vale for your OS.

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.

Note: livereload seems not to be working on Windows.

Building the Docs

Run make preview to 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

Lint

Lint all:

make proofread

Lint one file (e.g. README.md):

make proofread path=README.md

Lint one folder (e.g. getting-started):

make proofread path=getting-started

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.