search

projectatomic / container-best-practices

Container Best Practices
Other
166 stars 70 forks source link

WIP: Moving some sections around in the linter docs and adding more template documentation #103

Closed dav1x closed 8 years ago

dav1x commented 8 years ago

This should be finalized and ready for merge if everything looks fine.

dav1x commented 8 years ago

@aweiteka @eliskasl @imcleod

Any of you amazing writers/containerers want to review my work (im sure its riddled with errors :))

eliskasl commented 8 years ago

asciidoctor: WARNING: creating/creating_index.adoc: line 707: section title out of sequence: expected level 4, got level 5 asciidoctor: WARNING: creating/creating_index.adoc: line 714: section title out of sequence: expected level 4, got level 5

^^ you skipped one level when making a subsection, not sure if intentionally.

As someone not very familiar with npm, it took me a while to figure out where the linter was installed (when I followed CBP only) and how I should run it, so I would either expand it here or simply point readers to the linter's readme.

At a few places, there is a double space instead one between words and punctuation marks.

Otherwise good! :)

dav1x commented 8 years ago

@eliskasl Any chance you can merge this?