docs.janusgraph.org

This repository contains the generated documentation which is served on https://docs.janusgraph.org . To update the documentation for a particular version of JanusGraph, do not send a PR manually updating HTML files, because those changes will be overwritten in the next docs update.

Instead, please do the following:

1. modify the source AsciiDoc files in janusgraph/docs
2. build the docs using janusgraph/docs/build-and-copy-docs.sh
3. preview the output files from the script above locally in your browser to verify that everything looks as expected
4. create a feature branch with these files to be used for your PR
5. also create a gh-pages branch to point to the same commit as your feature branch for the preview site
6. publish a preview of your changes on GitHub, making appropriate substitutions in the instructions, i.e, s/janusgraph.org/docs.janusgraph.org/g, so that others can preview it easily by pushing the gh-pages branch with your HTML pages to your fork
7. create a PR using your feature branch and link to your preview site so that others can see the changes without having to rebuild your PR manually