diff options
31 files changed, 70 insertions, 8 deletions
diff --git a/doc/authentication.txt b/doc/authentication.txt index 56cb7ce3e..ae585da5b 100644 --- a/doc/authentication.txt +++ b/doc/authentication.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _authentication: + ============== Authentication ============== diff --git a/doc/getting_started/index.txt b/doc/getting_started/index.txt index 2480447f1..a6994e714 100644 --- a/doc/getting_started/index.txt +++ b/doc/getting_started/index.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _getting_started-index: + =========== Using Bcfg2 =========== diff --git a/doc/plugins/generators/account.txt b/doc/plugins/generators/account.txt index 9a2718ce5..9a37b2c69 100644 --- a/doc/plugins/generators/account.txt +++ b/doc/plugins/generators/account.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _plugins-generators-account: + ======= Account ======= diff --git a/doc/plugins/generators/cfg.txt b/doc/plugins/generators/cfg.txt index e4e342842..3870e8386 100644 --- a/doc/plugins/generators/cfg.txt +++ b/doc/plugins/generators/cfg.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _plugins-generators-cfg: + === Cfg === diff --git a/doc/plugins/generators/decisions.txt b/doc/plugins/generators/decisions.txt index 079e748f9..67860b86c 100644 --- a/doc/plugins/generators/decisions.txt +++ b/doc/plugins/generators/decisions.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _plugins-generators-decisions: + ========= Decisions ========= diff --git a/doc/plugins/generators/deps.txt b/doc/plugins/generators/deps.txt index 9b2772f72..890fe0c39 100644 --- a/doc/plugins/generators/deps.txt +++ b/doc/plugins/generators/deps.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _plugins-generators-deps: + ==== Deps ==== diff --git a/doc/plugins/generators/hostbase.txt b/doc/plugins/generators/hostbase.txt index a03dd2f82..20cab349a 100644 --- a/doc/plugins/generators/hostbase.txt +++ b/doc/plugins/generators/hostbase.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _plugins-generators-hostbase: + ======== Hostbase ======== diff --git a/doc/plugins/generators/nagiosgen.txt b/doc/plugins/generators/nagiosgen.txt index fd33fe374..99e304309 100644 --- a/doc/plugins/generators/nagiosgen.txt +++ b/doc/plugins/generators/nagiosgen.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _plugins-generators-nagiosgen: + ========= NagiosGen ========= diff --git a/doc/plugins/generators/packages.txt b/doc/plugins/generators/packages.txt index c7ac2deea..5efe5706d 100644 --- a/doc/plugins/generators/packages.txt +++ b/doc/plugins/generators/packages.txt @@ -1,3 +1,5 @@ +.. -*- mode: rst -*- + .. _plugins-generators-packages: ======== diff --git a/doc/plugins/generators/pkgmgr.txt b/doc/plugins/generators/pkgmgr.txt index fc15fad79..ddd8a0792 100644 --- a/doc/plugins/generators/pkgmgr.txt +++ b/doc/plugins/generators/pkgmgr.txt @@ -1,3 +1,5 @@ +.. -*- mode: rst -*- + .. _plugins-generators-pkgmgr: ====== diff --git a/doc/plugins/generators/rules.txt b/doc/plugins/generators/rules.txt index 94510d91f..d05fef773 100644 --- a/doc/plugins/generators/rules.txt +++ b/doc/plugins/generators/rules.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _plugins-generators-rules: + ===== Rules ===== diff --git a/doc/plugins/generators/sshbase.txt b/doc/plugins/generators/sshbase.txt index 4741fc8eb..7ce066cc7 100644 --- a/doc/plugins/generators/sshbase.txt +++ b/doc/plugins/generators/sshbase.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _plugins-generators-sshbase: + ======= SSHbase ======= diff --git a/doc/plugins/generators/tcheetah.txt b/doc/plugins/generators/tcheetah.txt index 5dcc466c0..4c3a8972f 100644 --- a/doc/plugins/generators/tcheetah.txt +++ b/doc/plugins/generators/tcheetah.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _plugins-generators-tcheetah: + ======== TCheetah ======== diff --git a/doc/plugins/generators/tgenshi.txt b/doc/plugins/generators/tgenshi.txt index 5794bac25..36b0dd8ea 100644 --- a/doc/plugins/generators/tgenshi.txt +++ b/doc/plugins/generators/tgenshi.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _plugins-generators-tgenshi: + ======= TGenshi ======= diff --git a/doc/plugins/grouping/bb.txt b/doc/plugins/grouping/bb.txt index 806f180e8..3c0846975 100644 --- a/doc/plugins/grouping/bb.txt +++ b/doc/plugins/grouping/bb.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _plugins-grouping-bb: + == BB == diff --git a/doc/plugins/grouping/metadata.txt b/doc/plugins/grouping/metadata.txt index f9ad44954..b82f98e28 100644 --- a/doc/plugins/grouping/metadata.txt +++ b/doc/plugins/grouping/metadata.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _plugins-grouping-metadata: + ======== Metadata ======== diff --git a/doc/plugins/index.txt b/doc/plugins/index.txt index a478f6a8f..f0c82c030 100644 --- a/doc/plugins/index.txt +++ b/doc/plugins/index.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _plugins-index: + ======= Plugins ======= @@ -8,8 +10,8 @@ Plugins are the source of all logic used in building a config. They can perform #. Generating configuration inventory lists for clients #. Generating configuration entry contents for clients -#. Probing client-side state (like hardware inventory, etc) -- the generic client probing mechanism is described at :doc:`probes`. -#. Automating administrative tasks (e.g. :doc:`generators/sshbase` which automates ssh key management) +#. Probing client-side state (like hardware inventory, etc) -- the generic client probing mechanism is described at :ref:`plugins-probes`. +#. Automating administrative tasks (e.g. :ref:`plugins-generators-sshbase` which automates ssh key management) #. Generating client per-entry installation decision-lists Enabling Plugins @@ -82,7 +84,7 @@ Plugin Roles (in 1.0) In version 1.0, plugins have been refactored into a series of roles. This are fine-grained plugin capabilities that govern how the server core interacts with plugins. -More details can be found in :doc:`plugin-roles` +More details can be found in :ref:`plugins-plugin-roles` .. toctree:: :hidden: diff --git a/doc/plugins/plugin-roles.txt b/doc/plugins/plugin-roles.txt index f26c79cee..5bfa815c7 100644 --- a/doc/plugins/plugin-roles.txt +++ b/doc/plugins/plugin-roles.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _plugins-plugin-roles: + ============ Plugin Roles ============ diff --git a/doc/plugins/probes.txt b/doc/plugins/probes.txt index a888b776d..45e967423 100644 --- a/doc/plugins/probes.txt +++ b/doc/plugins/probes.txt @@ -1,12 +1,14 @@ .. -*- mode: rst -*- +.. _plugins-probes: + ====== Probes ====== At times you need to gather information from a client machine before you can generate its configuration. For example, if some of your machines have both a local scratch disk and a system disk while others only have the system disk, you would want to know this information to correctly generate an `/etc/auto.master` autofs config file for each type. Here we will look at how to do this. -First you will need to set up the TCheetah plugin, as described on the :doc:`generators/tcheetah` page. +First you will need to set up the TCheetah plugin, as described on the :ref:`plugins-generators-tcheetah` page. Next, we need to create a `Probes` directory in our toplevel repository location:: diff --git a/doc/plugins/statistics/dbstats.txt b/doc/plugins/statistics/dbstats.txt index 001067974..942f2ba7a 100644 --- a/doc/plugins/statistics/dbstats.txt +++ b/doc/plugins/statistics/dbstats.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _plugins-statistics-dbstats: + ======= DBStats ======= diff --git a/doc/plugins/statistics/statistics.txt b/doc/plugins/statistics/statistics.txt index 4aae9c0f2..8a00dbe7d 100644 --- a/doc/plugins/statistics/statistics.txt +++ b/doc/plugins/statistics/statistics.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _plugins-statistics-statistics: + ========== Statistics ========== diff --git a/doc/plugins/structures/base.txt b/doc/plugins/structures/base.txt index b63ee5cc9..eebeadd48 100644 --- a/doc/plugins/structures/base.txt +++ b/doc/plugins/structures/base.txt @@ -1,7 +1,9 @@ .. -*- mode: rst -*- +.. _plugins-structures-base: + ==== Base ==== -The Base plugin is a structure plugin that provides the ability to add lists of unrelated entries into client configuration entry inventories. Base works much like Bundler in its file format. The main difference between Base and Bundler is that Base files are included in all clients' configuration whereas bundles must be included explicitly in your Metadata. See the :doc:`bundler` page for details. +The Base plugin is a structure plugin that provides the ability to add lists of unrelated entries into client configuration entry inventories. Base works much like Bundler in its file format. The main difference between Base and Bundler is that Base files are included in all clients' configuration whereas bundles must be included explicitly in your Metadata. See the :ref:`plugins-structures-bundler` page for details. diff --git a/doc/plugins/structures/bundler.txt b/doc/plugins/structures/bundler.txt index 9d663e90c..86f3dbf08 100644 --- a/doc/plugins/structures/bundler.txt +++ b/doc/plugins/structures/bundler.txt @@ -1,3 +1,5 @@ +.. -*- mode: rst -*- + .. _plugins-structures-bundler: ======= @@ -90,7 +92,7 @@ In some cases, configuration files need to include the client's hostname in thei <Path name='/etc/package-${metadata.hostname}'/> </Bundle> -Depending on the circumstance, these configuration files can either be handled by individual entries in :doc:`../generators/cfg`, :doc:`../generators/tcheetah`, or :doc:`../generators/tgenshi`, or can be mapped to a single entry by using the [wiki:altsrc] feature. +Depending on the circumstance, these configuration files can either be handled by individual entries in :ref:`plugins-generators-cfg`, :ref:`plugins-generators-tcheetah`, or :ref:`plugins-generators-tgenshi`, or can be mapped to a single entry by using the [wiki:altsrc] feature. In this example, configuration file names are built using probed results from the client. getmac is a probe that gathers client MAC addresses and returns them in a newline delimited string. diff --git a/doc/plugins/version/bzr.txt b/doc/plugins/version/bzr.txt index d4e624daf..58cc1930f 100644 --- a/doc/plugins/version/bzr.txt +++ b/doc/plugins/version/bzr.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _plugins-version-bzr: + === Bzr === diff --git a/doc/plugins/version/fossil.txt b/doc/plugins/version/fossil.txt index d77e45693..36c0c204a 100644 --- a/doc/plugins/version/fossil.txt +++ b/doc/plugins/version/fossil.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _plugins-version-fossil: + ====== Fossil ====== diff --git a/doc/plugins/version/git.txt b/doc/plugins/version/git.txt index 1b538f475..8ec30bc6a 100644 --- a/doc/plugins/version/git.txt +++ b/doc/plugins/version/git.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _plugins-version-git: + === Git === diff --git a/doc/plugins/version/svn.txt b/doc/plugins/version/svn.txt index e5ceb7aef..284ed5dea 100644 --- a/doc/plugins/version/svn.txt +++ b/doc/plugins/version/svn.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _plugins-version-svn: + === Svn === diff --git a/doc/quickstart/centos.txt b/doc/quickstart/centos.txt index b48f0cbb7..d8668f0e2 100644 --- a/doc/quickstart/centos.txt +++ b/doc/quickstart/centos.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _quickstart-centos: + This is a complete getting started guide for CentOS =================================================== diff --git a/doc/quickstart/index.txt b/doc/quickstart/index.txt index 53c6536e1..11bb03083 100644 --- a/doc/quickstart/index.txt +++ b/doc/quickstart/index.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _quickstart-index: + ========== Quickstart ========== @@ -14,8 +16,8 @@ or to drop in on our `IRC channel`_. For distribution-specific guides, choose one of the following: - * :doc:`centos` - * :doc:`ubuntu` + * :ref:`quickstart-centos` + * :ref:`quickstart-ubuntu` Get and Install Bcfg2 Server ============================ diff --git a/doc/quickstart/ubuntu.txt b/doc/quickstart/ubuntu.txt index 933d46401..b4a0b38fe 100644 --- a/doc/quickstart/ubuntu.txt +++ b/doc/quickstart/ubuntu.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _quickstart-ubuntu: + This is a complete getting started guide for Ubuntu =================================================== diff --git a/doc/unsorted/index.txt b/doc/unsorted/index.txt index bed264929..52c5becb1 100644 --- a/doc/unsorted/index.txt +++ b/doc/unsorted/index.txt @@ -1,5 +1,7 @@ .. -*- mode: rst -*- +.. _unsorted-index: + ============= Unsorted Docs ============= |