Burnout.io provides resources to prevent IT burnout. It has moved to: burnoutio.readthedocs.io

Contributing

We value your ideas! If you'd like to help improve Burnout.io, do whatever works best for you:

• Open an issue,
• Fork the project and submit a PR

Things you should know:

• This project is written in reStructuredText and Markdown
• Hosted by Read the Docs
• Tested by rendering in Sphinx on Travis CI

The only RST file in the project is the index.rst file. All pages are written in Markdown.

If you are looking to add content, fix formatting, syntax, typos or other wonderful things, please follow this process:

• Clone the project
• Install Sphinx: pip install -r requirements.txt
• Check out a branch to make your changes on: git checkout --branch <my_topic>
• Execute make html to build the docs in to _build/
• Make your changes
• Execute make html again and verify your changes don't cause any warnings/errors
• Commit with a descriptive message, and submit a pull request from your branch to master
• We'll review the change, and either merge it or provide some feedback. Community review is also encouraged.