summaryrefslogtreecommitdiffstats
path: root/doc/help/index.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/help/index.txt')
-rw-r--r--doc/help/index.txt42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/help/index.txt b/doc/help/index.txt
new file mode 100644
index 000000000..63c2ca350
--- /dev/null
+++ b/doc/help/index.txt
@@ -0,0 +1,42 @@
+.. -*- mode: rst -*-
+
+.. _help-index:
+
+=======================
+Getting Help with Bcfg2
+=======================
+
+Having trouble? We'd like to help!
+
+There are several ways to get in touch with the Bcfg2 community.
+
+* Try the :ref:`FAQ <faq-index>` -- it's got answers to many common
+ questions.
+* Check the :ref:`help-troubleshooting` page to see if you can narrow
+ down the cause of your issue.
+* Looking for specific information? Try the :ref:`genindex`,
+ :ref:`modindex`, or the :ref:`detailed table of contents <contents>`.
+* Search for information in the :ref:`help-mailinglist`.
+* Visit our :ref:`help-irc`, or search the `IRC logs`_.
+
+Note that the IRC channel tends to be much busier than the mailing
+list; use whichever seems most appropriate for your query, but don't
+let the lack of mailing list activity make you think the project isn't
+active.
+
+.. _IRC logs: http://colabti.org/irclogger/irclogger_logs/bcfg2
+.. _Bcfg2 mailing list archives: http://trac.mcs.anl.gov/projects/bcfg2/wiki/MailingList
+.. _Trac ticket tracker: http://trac.mcs.anl.gov/projects/bcfg2/wiki
+
+Report A Bug
+============
+
+Report bugs with Bcfg2 on the `Trac ticket tracker`_.
+
+.. toctree::
+ :hidden:
+
+ mailinglist
+ irc
+ faq/index
+ troubleshooting