Name: container-best-practices
Owner: Project Atomic
Description: Container Best Practices
Created: 2015-04-10 15:16:47.0
Updated: 2018-05-14 06:10:20.0
Pushed: 2018-03-06 13:28:37.0
Size: 646
Language: Python
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
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:
make html
make check
to spellcheck the documents. Update personal dictionary file containers.dict
with any non-English words.Create local index.html
file
docker run --rm -it -v `pwd`:/documents/:Z asciidoctor/docker-asciidoctor make html
clean
This removes all generated files.
publish
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.