From 865a2df854017406404f007ddbcad84e341cb686 Mon Sep 17 00:00:00 2001 From: Markus Unterwaditzer Date: Sat, 20 Feb 2016 21:44:15 +0100 Subject: [PATCH 1/3] Add IRC channel to docs --- CONTACT.rst | 13 +++++++++++++ CONTRIBUTING.rst | 3 +++ docs/contact.rst | 1 + 3 files changed, 17 insertions(+) create mode 100644 CONTACT.rst create mode 100644 docs/contact.rst diff --git a/CONTACT.rst b/CONTACT.rst new file mode 100644 index 0000000..5152003 --- /dev/null +++ b/CONTACT.rst @@ -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 `_ for + concrete bug reports and feature requests. + +* Lastly, you can also `contact the author directly + `_. diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 76df6e3..5f31ebf 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,3 +1,6 @@ +**Important:** Please read `CONTACT.rst `_ for questions and +support requests. + Reporting bugs ============== diff --git a/docs/contact.rst b/docs/contact.rst new file mode 100644 index 0000000..7a2eff1 --- /dev/null +++ b/docs/contact.rst @@ -0,0 +1 @@ +.. include:: ../CONTACT.rst From 36d8b535d72b63788de20fb7feaa1c25e4d9ac40 Mon Sep 17 00:00:00 2001 From: Markus Unterwaditzer Date: Sat, 20 Feb 2016 21:48:08 +0100 Subject: [PATCH 2/3] Update README to deduplicate docs --- README.rst | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index e706c16..f2a099e 100644 --- a/README.rst +++ b/README.rst @@ -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 + `_ 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 -`_. - -.. [1] Or ``$XDG_CONFIG_HOME/vdirsyncer/config`` (normally - ``~/.config/vdirsyncer/config``) for XDG-Basedir spec compliance. +* See `CONTACT.rst `_ for help and support. Donations ========= From 452cec177857dbca277dfed151f8a28d0b98f9b0 Mon Sep 17 00:00:00 2001 From: Markus Unterwaditzer Date: Sat, 20 Feb 2016 21:56:02 +0100 Subject: [PATCH 3/3] Restructure docs --- docs/config.rst | 6 +++--- docs/contributing.rst | 5 ----- docs/index.rst | 3 +-- docs/problems.rst | 11 ++++------- 4 files changed, 8 insertions(+), 17 deletions(-) delete mode 100644 docs/contributing.rst diff --git a/docs/config.rst b/docs/config.rst index 2bc9b6d..117f2b1 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -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:: diff --git a/docs/contributing.rst b/docs/contributing.rst deleted file mode 100644 index ae30b4c..0000000 --- a/docs/contributing.rst +++ /dev/null @@ -1,5 +0,0 @@ -============ -Contributing -============ - -.. include:: ../CONTRIBUTING.rst diff --git a/docs/index.rst b/docs/index.rst index 82aec79..6805b08 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -27,7 +27,6 @@ Table of Contents config supported problems - vdir - contributing changelog + contact license diff --git a/docs/problems.rst b/docs/problems.rst index 7a828b8..537b5ec 100644 --- a/docs/problems.rst +++ b/docs/problems.rst @@ -1,11 +1,8 @@ -========================== -Support and Known Problems -========================== - -For any unanswered questions or problems, `open an issue on GitHub -`_ or `contact me directly -`_. +============== +Known Problems +============== +For any unanswered questions or problems, see :doc:`contact`. .. _debian-urllib3: