diff options
Diffstat (limited to 'doc/development')
| -rw-r--r-- | doc/development/docstyleguide.txt | 16 | ||||
| -rw-r--r-- | doc/development/index.txt | 11 |
2 files changed, 27 insertions, 0 deletions
diff --git a/doc/development/docstyleguide.txt b/doc/development/docstyleguide.txt new file mode 100644 index 000000000..ef94bf232 --- /dev/null +++ b/doc/development/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/development/index.txt b/doc/development/index.txt index 4e2f29a54..6ed00f861 100644 --- a/doc/development/index.txt +++ b/doc/development/index.txt @@ -2,6 +2,7 @@ .. _development-index: +================= Bcfg2 Development ================= @@ -300,5 +301,15 @@ do so. We will call our new plugin `MyMetadata`. #. Add MyMetadata to ``src/lib/Server/Plugins/__init__.py`` #. Replace Metadata with MyMetadata in the plugins line of bcfg2.conf + +Documentation +------------- + +One of the areas where everyone can help is with the documentation. *Insert verbiage on how people can help.* + + + .. toctree:: :maxdepth: 1 + + docstyleguide
\ No newline at end of file |