diff options
| -rw-r--r-- | doc/docstyleguide.txt | 16 | ||||
| -rw-r--r-- | doc/gettinghelp.txt | 7 |
2 files changed, 22 insertions, 1 deletions
diff --git a/doc/docstyleguide.txt b/doc/docstyleguide.txt new file mode 100644 index 000000000..ef94bf232 --- /dev/null +++ b/doc/docstyleguide.txt @@ -0,0 +1,16 @@ +.. -*- mode: rst -*- + +.. _doc-styleguide: + +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. + +Basics +------ + +: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. diff --git a/doc/gettinghelp.txt b/doc/gettinghelp.txt index 03c146acc..8db873aa4 100644 --- a/doc/gettinghelp.txt +++ b/doc/gettinghelp.txt @@ -14,7 +14,12 @@ Having trouble? We'd like to help! * Ask a question in the `#bcfg2 IRC channel`_, or search the `IRC logs`_ to see if its been asked before. -* Report bugs with Bcfg2 in our `ticket tracker`_. +.. _report-a-bug: + +Report A Bug +************ + +Report bugs with Bcfg2 in our `ticket tracker`_. .. _Bcfg2 mailing list archives: http://trac.mcs.anl.gov/projects/bcfg2/wiki/MailingList .. _#bcfg2 IRC channel: irc://irc.freenode.net/bcfg2 |