Contribute: Documentation

If you want to contribute to KairosDB documentation, here is a small guide on how to do that. If you have any issues with this tutorial, feel free to ask a question or event improve the guide.

1. Installing dependencies:
First of all, you need to install Sphinx, a Python document generator. For example, in Debian/Ubuntu based distributions you should run something like apt-get install python-sphinx and in RedHat/Fedora based distros you should run sudo dnf install python-sphinx. For other operating systems, take a look at "Installing Sphinx" page in the official documentation.

2. Clone the project to your local host:
In order to edit KairosDB documentation you need to download the project to your computer. For that, just run: git clone [email protected]:kairosdb/kairosdb.git.

3. Make the changes you want to submit:
After cloning the project, a new folder called kairosdb containing the KairosDB project will be created in your computer. The following directories will be useful for you:

• src/docs/ -> the documentation itself. If you want to edit or add new pages to KairosDB documentation, then here is where you should look.
• build/docs/ -> in order to have the documentation in a presentable way you should build the documentation (we'll explain later). The built files will be available under this directory.

Now you should modify the files you want in src/docs. If you don't understand what you should do, then take a look in the Sphinx official documentation.

4. Checking your modifications:

After modify the files you want to, you should build the project. In order to do that, open your Terminal, go to the "kairosdb" folder and run:

export CLASSPATH=tools/tablesaw-1.2.2.jar
java make
java make docs-rebuild

After that, YOUR VERSION of documentation will be available under build/docs/. To check the modifications you've made, open the index page of the documentation (located at build/docs/index.html) in your browser. If everything is okay you can make a pull request submitting your work. Thank you for the contribution!