Checklist

A Checklist For All Trainings In This Repository

Repository Structure Per Training Directory

Each training lives in its own directory and should be able to build by its own.

• A conf.py, configured per training
• A index.rst
• A glossary with 'special words' for this certain training ¹

Tests

This tests will be run against the repository via CI.

However if you start working on a document it would be helpful and faster to include these already in your local writing flow.

• Spell-check
• Word consistency (like GitHub, JavaScript)
• No 'So' at the beginning of sentences
• One sentence per line
• Line limit more or less 130 characters
• Documents not longer than 1000 lines
• Link-check
• Catch insensitive, inconsiderate writing (http://alexjs.com/)

Bonus Tests

• Check for Unexpanded Acronym

Notes

1 Example: In the deployment training we have AWS (Amazon Web Services) as 'special'. ↩