blob: 59db583622f66aded9d4cc3bc16f99e0cfe4dbab (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
|
.. -*- 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.
**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`.
Sections
--------
Unless necessary, all the documentation follows the sections header
rules available at http://docs.python.org/documenting/rest.html#sections.
|
