DataTorrent Documentation

DataTorrent documentation repository for content available on http://docs.datatorrent.com/

Documentation is written in Markdown format and statically generated into HTML using MkDocs. All documentation is located in the docs directory, and mkdocs.yml file describes the navigation structure of the published documentation.

Authoring

Start by installing mkdocs using Python package manager, pip. For additional installation questions see http://www.mkdocs.org/

pip install mkdocs

New pages can be added under docs or related sub-category, and a reference to the new page must be added to the mkdocs.yml file to make it available in the navigation. Embedded images are typically added to images folder at the same level as the new page.

When creating or editing pages, it can be useful to see the live results, and how the documents will appear when published. Live preview feature is available by running the following command at the root of the repository:

mkdocs serve

For additional details see writing your docs guide.

Site Configuration

Guides on applying site-wide configuration and themeing are available on the MkDocs site.

Hosting

Currently docs.datatorrent.com is hosted on Github Pages. The deployment requires that a custom CNAME be present at docs level, and DNS entry for docs.datatorrent.com point to datatorrent.github.io.

Deployment

NOTE Please make sure to use mkdocs v0.16.0 or later by running mkdocs --version. If you have an older version of mkdocs installed upgrade with:

sudo pip install --upgrade mkdocs

Deployment is done from master branch of the repository by executing the following command:

mkdocs gh-deploy --clean

This results in all the documentation under docs being statically generated into HTML files and deployed as top level in gh-pages branch. For more details on how this is done see MkDocs - Deploying Github Pages.