README.md

Cloud Pipeline documentation

Cloud Pipeline documentation is provided in a Markdown format, that could be viewed directly from GitHub or could be built into html representation

Documentation index

The following sections are currently covered in a documentation:

• Introduction
  • CP introduction
• Release notes
  • Release notes v.0.13
  • Release notes v.0.14
  • Release notes v.0.15
  • Release notes v.0.16
  • Release notes v.0.17
• User guide
  • Table of contents

Building documentation

MkDocs is used to build documentation into html representation. So make sure that all dependencies are installed according to the installation guide.

Once installed, obtain Markdown sources from GitHub:

$ git clone https://github.com/epam/Cloud-Pipeline.git
$ cd Cloud-Pipeline/docs

Run build

$ mkdocs build

This will create site/ folder, containing built html documentation.
To view documentation - navigate in Cloud-Pipeline/docs/site/ folder and launch index.html with a web-browser.