diff options
| author | Raul Cuza <raulcuza@gmail.com> | 2010-03-13 17:48:39 -0500 |
|---|---|---|
| committer | Raul Cuza <raulcuza@gmail.com> | 2010-03-13 17:48:39 -0500 |
| commit | 0567e56f058d2f3cb07520a1fe9237a7cb1dcc9a (patch) | |
| tree | 1ce6cf7b6e58a1c0fc2f3d10a237a01e1614e5df /doc | |
| parent | 05b15c2c3d606d13303346158a63603483f42c1a (diff) | |
| download | bcfg2-0567e56f058d2f3cb07520a1fe9237a7cb1dcc9a.tar.gz bcfg2-0567e56f058d2f3cb07520a1fe9237a7cb1dcc9a.tar.bz2 bcfg2-0567e56f058d2f3cb07520a1fe9237a7cb1dcc9a.zip | |
Added suggested usage for 'repository'. And 4 space = python happiness.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/development/docstyleguide.txt | 4 | ||||
| -rw-r--r-- | doc/glossary.txt | 22 |
2 files changed, 15 insertions, 11 deletions
diff --git a/doc/development/docstyleguide.txt b/doc/development/docstyleguide.txt index ef94bf232..fd6bd1aa1 100644 --- a/doc/development/docstyleguide.txt +++ b/doc/development/docstyleguide.txt @@ -12,5 +12,9 @@ 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`. diff --git a/doc/glossary.txt b/doc/glossary.txt index d475218f2..f7e8d8e5b 100644 --- a/doc/glossary.txt +++ b/doc/glossary.txt @@ -6,33 +6,33 @@ Glossary .. glossary:: :sorted: - client + client - generator + generator A type of plugin which provides file contents. For example Cfg or TGenshi. - Genshi + Genshi A Python-based templating engine. `Genshi Homepage`_. - group + group A "tag" assigned to a client through a probe or other plugin. - irc channel + irc channel #bcfg2 on freenode - probe + probe A script that executes on a client machine and sets client metadata such as group membership. - profile + profile A special type of group that a client is explicitly assigned to. - structure + structure - repository - A colledtion of folders and files that make up the configurations that Bcfg2 applies to server. The repository is located at ``/var/lib/bcfg2`` by default. This is not to be confused with a :term:VCS repository, which is an excellent place to pull your Bcfg2 repository from to manage changes. + repository + A colledtion of folders and files that make up the configurations that Bcfg2 applies to server. The repository is located at ``/var/lib/bcfg2`` by default. This is not to be confused with a :term:VCS repository, which is an excellent place to pull your Bcfg2 repository from to manage changes. When used a lone, repository refers to a Bcfg2 repository. VCS - Stands for `Version Control System <http://en.wikipedia.org/wiki/Revision_control>_. + Stands for `Version Control System <http://en.wikipedia.org/wiki/Revision_control>`_. .. _Genshi Homepage: http://genshi.edgewall.org/ |