summaryrefslogtreecommitdiffstats
path: root/doc/index.txt
diff options
context:
space:
mode:
authorKamil Kisiel <kamil@kamilkisiel.net>2010-01-14 21:29:31 +0000
committerKamil Kisiel <kamil@kamilkisiel.net>2010-01-14 21:29:31 +0000
commitac053254555f4e7983ef84e3cce6c3ccd6b15a41 (patch)
tree824126bafd8d0c99f44e9bb6e6b681cff302ea6f /doc/index.txt
parent295979b3bc2d4c6e1a11e33ec05172f00dbf147b (diff)
downloadbcfg2-ac053254555f4e7983ef84e3cce6c3ccd6b15a41.tar.gz
bcfg2-ac053254555f4e7983ef84e3cce6c3ccd6b15a41.tar.bz2
bcfg2-ac053254555f4e7983ef84e3cce6c3ccd6b15a41.zip
doc: More documentation organization, added a couple of Glossary items
git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@5681 ce84e21b-d406-0410-9b95-82705330c041
Diffstat (limited to 'doc/index.txt')
-rw-r--r--doc/index.txt33
1 files changed, 8 insertions, 25 deletions
diff --git a/doc/index.txt b/doc/index.txt
index ca96bfe1f..2256b5555 100644
--- a/doc/index.txt
+++ b/doc/index.txt
@@ -1,31 +1,11 @@
.. _index:
=====================
-Bcfg2's documentation
+Bcfg2 Manual (v1.0.1)
=====================
-Getting help
-============
-
-Having trouble? We'd like to help!
-
-* Try the :ref:`FAQ <faq-index>` -- it's got answers to many common questions.
-
-* Looking for specific information? Try the :ref:`genindex`, :ref:`modindex` or the :ref:`detailed table of contents <contents>`.
-
-* Search for information in the `Bcfg2 mailing list archives`_.
-
-* 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`_.
-
-.. _Bcfg2 mailing list archives: http://trac.mcs.anl.gov/projects/bcfg2/wiki/MailingList
-.. _#bcfg2 IRC channel: irc://irc.freenode.net/bcfg2
-.. _IRC logs: http://colabti.org/irclogger/irclogger_logs/bcfg2
-.. _ticket tracker: http://trac.mcs.anl.gov/projects/bcfg2/wiki
-
-Introduction
-============
+What is Bcfg2?
+==============
Bcfg2 helps system administrators produce a consistent, reproducible,
and verifiable description of their environment, and offers
@@ -39,9 +19,9 @@ developed in the `Mathematics and Computer Science Division`_ of
It is based on an operational model in which the specification can be
used to validate and optionally change the state of clients, but in a
-feature unique to bcfg2 the client's response to the specification can
+feature unique to Bcfg2 the client's response to the specification can
also be used to assess the completeness of the specification. Using
-this feature, bcfg2 provides an objective measure of how good a job an
+this feature, Bcfg2 provides an objective measure of how good a job an
administrator has done in specifying the configuration of client
systems. Bcfg2 is therefore built to help administrators construct an
accurate, comprehensive specification.
@@ -55,6 +35,9 @@ systems are constantly changing; if required in your environment,
Bcfg2 can enable the construction of complex change management and
deployment strategies.
+What Operating Systems Does Bcfg2 Support?
+==========================================
+
Bcfg2 is fairly portable. It has been successfully run on:
* `AIX`_, `FreeBSD`_, `OpenBSD`_, `Mac OS X`_, `OpenSolaris`_,