diff options
| author | Sol Jerome <solj@ices.utexas.edu> | 2010-03-23 13:41:11 +0000 |
|---|---|---|
| committer | Sol Jerome <solj@ices.utexas.edu> | 2010-03-25 17:19:43 -0500 |
| commit | 723f580e5ea060b87155110ca59c7443f270cbe3 (patch) | |
| tree | 724a7889c351d506849c410dc6d3344cf8d1578c /doc/development | |
| parent | 92906fdae89f11ebaa9a5cb32e3747b2a68262c8 (diff) | |
| download | bcfg2-723f580e5ea060b87155110ca59c7443f270cbe3.tar.gz bcfg2-723f580e5ea060b87155110ca59c7443f270cbe3.tar.bz2 bcfg2-723f580e5ea060b87155110ca59c7443f270cbe3.zip | |
doc: More suggested improvements from Philipp Riegger
Signed-off-by: Sol Jerome <solj@ices.utexas.edu>
git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@5788 ce84e21b-d406-0410-9b95-82705330c041
Diffstat (limited to 'doc/development')
| -rw-r--r-- | doc/development/docstyleguide.txt | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/doc/development/docstyleguide.txt b/doc/development/docstyleguide.txt index 401a43bc0..fda1037f3 100644 --- a/doc/development/docstyleguide.txt +++ b/doc/development/docstyleguide.txt @@ -5,17 +5,23 @@ Documentation Style Guide for Bcfg2 =================================== -This is a style guide to use when creating documentation for Bcfg2. It is meant to be helpful, not a hinderence. +This is a style guide to use when creating documentation for Bcfg2. It +is meant to be helpful, not a hinderence. Basics ------ -:Bcfg2: +**Bcfg2** + When referring to project, Bcfg2 is the preferred use of cases. -:Monospace fonts: - When referring to commands written on the command line use monospace fonts. +**Monospace fonts** + + When referring to commands written on the command line use monospace + fonts. -:Repository: - When used alone this refers to a Bcfg2 :term:`repository`. When there is a chance for confusion, for instance in documents also talking about :term:`VCS`, be sure to use the longer Bcfg2 :term:`repository`. +**Repository** + When used alone this refers to a Bcfg2 :term:`repository`. When there + is a chance for confusion, for instance in documents also talking + about :term:`VCS`, be sure to use the longer Bcfg2 :term:`repository`. |