Răsfoiți Sursa

Documentation: Added info about mailing list

Jonas Borgström 11 ani în urmă
părinte
comite
9ebeb0f98d
4 a modificat fișierele cu 21 adăugiri și 20 ștergeri
  1. 0 8
      README.rst
  2. 2 2
      docs/conf.py
  3. 4 4
      docs/global.rst.inc
  4. 15 6
      docs/index.rst

+ 0 - 8
README.rst

@@ -54,11 +54,3 @@ The tests are in the attic/testsuite package. To run the test suite use the
 following command::
 
   $ python -m attic.testsuite.run
-
-Contribute
-----------
-Found a bug? Have any ideas to improve attic? Add bug reports and feature
-requests to the `issue tracker <https://github.com/jborg/attic/issues>`_.
-
-You can also ask the author a question directly by
-`email <mailto:jonas@borgstrom.se>`_.

+ 2 - 2
docs/conf.py

@@ -48,9 +48,9 @@ copyright = '2010-2013, Jonas Borgström'
 # built documents.
 #
 # The short X.Y version.
-version = attic.__version__
+version = attic.__version__.split('-')[0]
 # The full version, including alpha/beta/rc tags.
-release = attic.__version__
+release = version
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

+ 4 - 4
docs/global.rst.inc

@@ -1,9 +1,8 @@
 .. highlight:: bash
 .. |project_name| replace:: ``Attic``
-.. |project_version| replace:: 0.7
-.. |package_dirname| replace:: Attic-|project_version|
+.. |package_dirname| replace:: Attic-|version|
 .. |package_filename| replace:: |package_dirname|.tar.gz
-.. |package_url| replace:: https://pypi.python.org/packages/source/A/Attic/Attic-0.7.tar.gz
+.. |package_url| replace:: https://pypi.python.org/packages/source/A/Attic/|package_filename|
 .. |git_url| replace:: https://github.com/jborg/attic.git
 .. _deduplication: https://en.wikipedia.org/wiki/Data_deduplication
 .. _AES: https://en.wikipedia.org/wiki/Advanced_Encryption_Standard
@@ -16,4 +15,5 @@
 .. _`msgpack-python`: https://pypi.python.org/pypi/msgpack-python/
 .. _homebrew: http://mxcl.github.io/homebrew/
 .. _issue tracker: https://github.com/jborg/attic/issues
-.. _userspace filesystems: https://en.wikipedia.org/wiki/Filesystem_in_Userspace
+.. _userspace filesystems: https://en.wikipedia.org/wiki/Filesystem_in_Userspace
+.. _librelist: http://librelist.com/

+ 15 - 6
docs/index.rst

@@ -38,11 +38,20 @@ User's Guide
    usage
    faq
 
-Contribute
-==========
+Getting help
+============
+
+If you've found a bug or have a concrete feature request you can add your bug
+report or feature request directly to the project `issue tracker`_. For more
+general questions or discussions a post to the mailing list is preferred.
+
+Mailing list
+------------
 
-Found a bug? Have any ideas to improve |project_name|? Add bug reports and
-feature requests to the `issue tracker`_.
+There is a mailing list for Attic on librelist_ you can use for feature
+requests and general discussions about Attic. A mailing list archive is
+available `here <http://librelist.com/browser/attic/>`_.
 
-You can also ask the author a question directly by
-`email <mailto:jonas@borgstrom.se>`_.
+To subscribe to the list send an email to attic@librelist.com and reply
+to the confirmation mail. Likevise To unsubscribe send an email to 
+attic-unsubscribe@librelist.com and reply to the confirmation mail.