From 4960c276ec3662c14803de5dcc167b47c9c6ad7f Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Wed, 29 Sep 2010 00:29:35 +0000 Subject: doc: Refactor help documents and add a link directly referencing them Signed-off-by: Sol Jerome git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@6081 ce84e21b-d406-0410-9b95-82705330c041 --- doc/_templates/layout.html | 3 ++- doc/contents.txt | 1 + doc/help/index.txt | 33 ++++++++++++++++++++++++++++++++ doc/help/irc.txt | 45 ++++++++++++++++++++++++++++++++++++++++++++ doc/help/mailinglist.txt | 24 +++++++++++++++++++++++ doc/index.txt | 2 +- doc/unsorted/ircchannel.txt | 32 ------------------------------- doc/unsorted/mailinglist.txt | 24 ----------------------- 8 files changed, 106 insertions(+), 58 deletions(-) create mode 100644 doc/help/index.txt create mode 100644 doc/help/irc.txt create mode 100644 doc/help/mailinglist.txt delete mode 100644 doc/unsorted/ircchannel.txt delete mode 100644 doc/unsorted/mailinglist.txt diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html index eb9f5b821..39c6f43b1 100644 --- a/doc/_templates/layout.html +++ b/doc/_templates/layout.html @@ -7,7 +7,8 @@ {% block rootrellink %}
  • home | 
    • -
  • search | 
    • + +
  • help | 
  • documentation »
    • {% endblock %} diff --git a/doc/contents.txt b/doc/contents.txt index 6b568547d..b2d96923f 100644 --- a/doc/contents.txt +++ b/doc/contents.txt @@ -11,6 +11,7 @@ Welcome to Bcfg2's documentation! index quickstart/index + help/index faq/index authentication getting_started/index diff --git a/doc/help/index.txt b/doc/help/index.txt new file mode 100644 index 000000000..bc713bcbe --- /dev/null +++ b/doc/help/index.txt @@ -0,0 +1,33 @@ +.. -*- mode: rst -*- + +.. _help-index: + +======================= +Getting Help with Bcfg2 +======================= + +Having trouble? We'd like to help! + +* Try the :ref:`FAQ ` -- 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 `. +* Search for information in the :ref:`help-mailinglist`. +* Visit our :ref:`help-irc` channel. + +.. _report-a-bug: + +Report A Bug +============ + +Report bugs with Bcfg2 on the `Trac ticket tracker`_. + +.. _Bcfg2 mailing list archives: http://trac.mcs.anl.gov/projects/bcfg2/wiki/MailingList +.. _Trac ticket tracker: http://trac.mcs.anl.gov/projects/bcfg2/wiki + +Other ways to get in touch +========================== + +.. toctree:: + :maxdepth: 2 + + irc + mailinglist diff --git a/doc/help/irc.txt b/doc/help/irc.txt new file mode 100644 index 000000000..37d2099d3 --- /dev/null +++ b/doc/help/irc.txt @@ -0,0 +1,45 @@ +.. -*- mode: rst -*- + +.. _help-irc: + +=== +IRC +=== + +The Bcfg2 IRC channel is `#bcfg2 on chat.freenode.net`_. It is home +to both support and development discussions. If you have a question, +suggestion, or just want to know about Bcfg2, please drop in and say hi. + +.. _#bcfg2 on chat.freenode.net: irc://chat.freenode.net/bcfg2 + +Archives are available at: http://colabti.org/irclogger/irclogger_logs/bcfg2. + +.. raw:: html + +
    + + +
    + in the timespan + + (yyyymmdd-yyyymmdd) +

    Options:
    +
    +
    +

    + +Administrative Note +=================== + +If the IRC logging stops working for a while, coordinate on #bcfg2 and +then bug **feb** on #irclogger (freenode), and stick around on that +channel until you get an answer (**feb** is great, but busy and in a +non-US time zone). Actually as long as **ilogger2** is logged in you +should be okay (**feb** looks at the logs). + +If you have private logs for the period of time **ilogger2** was off the +channel, you can convert them to the `format shown here`_, and **feb** +will incorporate them into the online logs. Be sure to strip out any +private messages in your logs first :-) + +.. _format shown here: http://colabti.org/irclogger/irclogger_log/bcfg2?date=2008-03-21,Fri;raw=on diff --git a/doc/help/mailinglist.txt b/doc/help/mailinglist.txt new file mode 100644 index 000000000..c77caa0c4 --- /dev/null +++ b/doc/help/mailinglist.txt @@ -0,0 +1,24 @@ +.. -*- mode: rst -*- + +.. _help-mailinglist: + +============ +Mailing List +============ + +To subscribe to the mailing list for Bcfg2 please visit the `bcfg-dev +mailman page`_ + +`Searchable archives`_ are available from Gmane. You can also read the +mailing list from any NNTP client via Gmane. + +.. _bcfg-dev mailman page: https://lists.mcs.anl.gov/mailman/listinfo/bcfg-dev +.. _Searchable archives: http://dir.gmane.org/gmane.comp.sysutils.bcfg2.devel + +.. raw:: html + +
    + + + +
    diff --git a/doc/index.txt b/doc/index.txt index 894996ffe..0479fea2d 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -107,4 +107,4 @@ direct support for an operating system's package and service formats are limited by the currently available :ref:`client-tools-index` (new client tools are pretty easy to add). Check the :ref:`FAQ ` for a more exact list of platforms on which Bcfg2 -works`. +works. diff --git a/doc/unsorted/ircchannel.txt b/doc/unsorted/ircchannel.txt deleted file mode 100644 index 4f4efa6e5..000000000 --- a/doc/unsorted/ircchannel.txt +++ /dev/null @@ -1,32 +0,0 @@ -.. -*- mode: rst -*- - -.. _unsorted-ircchannel: - -=========== -IRC Channel -=========== - -The Bcfg2 IRC channel is [irc://chat.freenode.net/bcfg2 #bcfg2 on chat.freenode.net]. It is home to both support and development discussions. If you have a question, suggestion, or just want to know about Bcfg2, please drop in and say hi. - -Archives are available at: [http://colabti.org/irclogger/irclogger_logs/bcfg2]. - -.. raw:: html - -
    - - -
    - in the timespan - - (yyyymmdd-yyyymmdd) -

    Options:
    -
    -
    -

    - -Administrative Note -=================== - -If the IRC logging stops working for a while, coordinate on #bcfg2 and then bug `feb` on #irclogger (freenode), and stick around on that channel until you get an answer (`feb` is great, but busy and in a non-US time zone). Actually as long as `ilogger2` is logged in you should be okay (`feb` looks at the logs). - -If you have private logs for the period of time `ilogger2` was off the channel, you can convert them to the [http://colabti.org/irclogger/irclogger_log/bcfg2?date=2008-03-21,Fri;raw=on format shown here], and `feb` will incorporate them into the online logs. Be sure to strip out any private messages in your logs first :-) diff --git a/doc/unsorted/mailinglist.txt b/doc/unsorted/mailinglist.txt deleted file mode 100644 index 72b971d77..000000000 --- a/doc/unsorted/mailinglist.txt +++ /dev/null @@ -1,24 +0,0 @@ -.. -*- mode: rst -*- - -.. _unsorted-mailinglist: - -============ -Mailing List -============ - -To subscribe to the mailing list for Bcfg2 please visit the `bcfg-dev -mailman page`_ - -`Searchable archives`_ are available from Gmane. You can also read the -mailing list from any NNTP client via Gmane. - -.. _bcfg-dev mailman page: https://lists.mcs.anl.gov/mailman/listinfo/bcfg-dev -.. _Searchable archives: http://dir.gmane.org/gmane.comp.sysutils.bcfg2.devel - -.. raw:: html - -
    - - - -
    -- cgit v1.2.3-1-g7c22