https://github.com/chaostoolkit/chaostoolkit-documentation

The Chaos Toolkit documentation
https://github.com/chaostoolkit/chaostoolkit-documentation

chaos-engineering chaos-toolkit chaostoolkit-doc

Last synced: 18 days ago
JSON representation

The Chaos Toolkit documentation

• Host: GitHub
• URL: https://github.com/chaostoolkit/chaostoolkit-documentation
• Owner: chaostoolkit
• License: apache-2.0
• Created: 2017-10-03T08:36:09.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-09-02T08:55:53.000Z (5 months ago)
• Last Synced: 2024-11-09T21:34:32.760Z (2 months ago)
• Topics: chaos-engineering, chaos-toolkit, chaostoolkit-doc
• Language: HTML
• Homepage: https://chaostoolkit.org
• Size: 23.8 MB
• Stars: 19
• Watchers: 8
• Forks: 32
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# The Chaos Toolkit documentation

[![Build and Deploy](https://github.com/chaostoolkit/chaostoolkit-documentation/actions/workflows/build_and_deploy.yaml/badge.svg)](https://github.com/chaostoolkit/chaostoolkit-documentation/actions/workflows/build_and_deploy.yaml)

Get to the [documentation][live] of the Chaos Toolkit.

[live]: https://chaostoolkit.org

## 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][venv]

and install the dependencies using [pip][] as follows:

```

pip install -r requirements.txt

```

[MkDocs]: http://www.mkdocs.org/

[Markdown]: https://daringfireball.net/projects/markdown/syntax

[venv]: https://virtualenv.pypa.io/en/stable/

[pip]: https://pip.pypa.io/en/stable/installing/

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.