Container Best Practices Guide
A collaborative project to document container-based application architecture, creation and management. The built version of this source can be viewed at http://docs.projectatomic.io/container-best-practices/
Please refer to the asciidoc user's guide: http://asciidoctor.org/docs/asciidoc-writers-guide/
Before submitting a pull request:
- Compile the document,
make checkto spellcheck the documents. Update personal dictionary file
containers.dictwith any non-English words.
Working with files
Compile docs from a container
sudo docker run --rm -it -v `pwd`:/documents/:Z asciidoctor/docker-asciidoctor make html
Clean up files
This removes all generated files.
Github serves HTML documents from the
gh-pages branch. This command will push to the branch.
aspell is used to spell check the document. This is run in a Travis job for all pull requests. Any non-English words should be added to
containers.dict with your commit. Ensure
make check passes.