The Chaos Toolkit documentation
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
extensions-doc-builder
sources
.atomist.yml
.gitattributes
.gitignore Leaner as some of the pages will move to the final site now (#28) May 14, 2018
.gitmodules Moved code outside #32 Jun 26, 2018
.travis.yml
LICENSE
README.md
ci.bash
mkdocs.yml Rearrange menu Sep 19, 2018
requirements.txt
schema.json Add background and secrets to schema Oct 11, 2017

README.md

The Chaos Toolkit documentation

Build Status Requirements Status

Get to the documentation of the Chaos Toolkit.

Contribute to the documentation

This project is based on MkDocs, a Python documentation generator based on Markdown.

To get started, install Python 3 on your machine, a virtual environment and install the dependencies using pip as follows:

$ pip install -r requirements.txt

Once the dependencies are installed you need to ensure you have also installed any submodules (i.e. source code for the docs is in a separate submodule) using:

$ git submodule update --init

Finally you can start a local server to view the docs:

$ mkdocs serve

If you wish to contribute to this documentation, please submit a PR with your changes for review.