Commit 62b117aa authored by anarcat's avatar anarcat
Browse files

add troubleshooting section

parent a4eadfdb
......@@ -5,6 +5,7 @@
If you have problems or question using Monkeysign, there are several
options at your disposal:
* Try to troubleshoot the issue yourself
* Write to the mailing list
* Chat on IRC
* File bug reports
......@@ -13,8 +14,27 @@ We of course welcome other contributions like documentation,
translations and patches, see the :doc:`contributing` guide for more
information on how to contribute to the project.
Troubleshooting
---------------
The basic way to troubleshoot Monkeysign is to run the same command as
you did when you had an error with the ``--verbose`` or, if that
doesn't yield satisfactory results, with the ``--debug`` output.
.. note:: The debug output outputs a lot of information, as it shows
the OpenPGP key material as it is exchanged with GnuPG. It
may be confusing for new users.
If you suspect there is a bug in Monkeysign specific to your
environment, you can also try to see if it is reproducible within the
test suite with ``monkeysign --test``. From there, you can either file
a bug report or try to fix the issue yourself, see the
:doc:`contributing` section for more information.
Otherwise, see below for more options to get support.
Mailing list
============
------------
Anyone can write to the mailing list at
monkeysphere@lists.riseup.net. You can `browse the archives
......@@ -34,7 +54,7 @@ write to the mailing list, you should explicitly mention that you are
talking about Monkeysign.
Chat
====
----
We are often present in realtime in the ``#monkeysphere`` channel of
the `OFTC network <https://www.oftc.net/>`_. You can join the channel
......@@ -47,7 +67,7 @@ interface
<iframe src="http://webchat.oftc.net/?nick=monkey.&channels=monkeysphere&prompt=1" width="647" height="400"></iframe>
Bug reports
===========
-----------
We want you to report bugs you find in Monkeysign. It's an important
part of contributing to a project, and all bug reports will be read and
......@@ -103,7 +123,7 @@ also documented by Debian users directly.
reports.
Debian BTS
----------
~~~~~~~~~~
You can also report bugs by email over the `Debian
BTS <http://bugs.debian.org/>`__, even if you are not using Debian. Use
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment