Merge pull request #338 from untitaker/irc-channel

Add IRC channel to docs
This commit is contained in:
Markus Unterwaditzer 2016-02-20 21:56:18 +01:00
commit 53dc69262e
8 changed files with 31 additions and 28 deletions

13
CONTACT.rst Normal file
View file

@ -0,0 +1,13 @@
===================
Support and Contact
===================
* The ``#vdirsyncer`` IRC channel on Freenode might be active, depending on
your timezone. Use it for support and general (including off-topic)
discussion.
* Open `a GitHub issue <https://github.com/untitaker/vdirsyncer/issues/>`_ for
concrete bug reports and feature requests.
* Lastly, you can also `contact the author directly
<https://unterwaditzer.net/contact.html>`_.

View file

@ -1,3 +1,6 @@
**Important:** Please read `CONTACT.rst <CONTACT.rst>`_ for questions and
support requests.
Reporting bugs
==============

View file

@ -22,19 +22,14 @@ It aims to be for CalDAV and CardDAV what `OfflineIMAP
.. image:: https://codecov.io/github/untitaker/vdirsyncer/coverage.svg?branch=master
:target: https://codecov.io/github/untitaker/vdirsyncer?branch=master
Installation and usage
======================
Links of interest
=================
If you already have it installed and want to quickly configure it, copy the
``config.example`` to ``~/.vdirsyncer/config`` [1]_ and edit it. Then run
``vdirsyncer sync``.
* Check out `the tutorial
<https://vdirsyncer.readthedocs.org/en/stable/tutorial.html>`_ for basic
usage.
If that method doesn't work for you or you want a deeper understanding of what
you just did, check out `the tutorial
<https://vdirsyncer.readthedocs.org/en/stable/tutorial.html>`_.
.. [1] Or ``$XDG_CONFIG_HOME/vdirsyncer/config`` (normally
``~/.config/vdirsyncer/config``) for XDG-Basedir spec compliance.
* See `CONTACT.rst <CONTACT.rst>`_ for help and support.
Donations
=========

View file

@ -1,6 +1,6 @@
=============
Configuration
=============
=========================
Full configuration manual
=========================
Vdirsyncer uses an ini-like format for storing its configuration. All values
are JSON, invalid JSON will get interpreted as string::

1
docs/contact.rst Normal file
View file

@ -0,0 +1 @@
.. include:: ../CONTACT.rst

View file

@ -1,5 +0,0 @@
============
Contributing
============
.. include:: ../CONTRIBUTING.rst

View file

@ -27,7 +27,6 @@ Table of Contents
config
supported
problems
vdir
contributing
changelog
contact
license

View file

@ -1,11 +1,8 @@
==========================
Support and Known Problems
==========================
For any unanswered questions or problems, `open an issue on GitHub
<https://github.com/untitaker/vdirsyncer/issues/new>`_ or `contact me directly
<https://unterwaditzer.net>`_.
==============
Known Problems
==============
For any unanswered questions or problems, see :doc:`contact`.
.. _debian-urllib3: