Commits

Mike Bayer committed 006d488

docs

Comments (0)

Files changed (3)

docs/build/front.rst

+============
+Front Matter
+============
+
+Information about the Dogpile project.
+
+Project Homepage
+================
+
+Dogpile is hosted on `Bitbucket <http://bitbucket.org>`_ - the lead project page is at https://bitbucket.org/zzzeek/dogpile.  Source
+code is tracked here using `Mercurial <http://mercurial.selenic.com/>`_.
+
+Releases and project status are available on Pypi at http://pypi.python.org/pypi/dogpile.
+
+The most recent published version of this documentation should be at http://packages.python.org/dogpile/.
+
+Installation
+============
+
+Install released versions of Dogpile from the Python package index with `pip <http://pypi.python.org/pypi/pip>`_ or a similar tool::
+
+    pip install dogpile
+
+Installation via source distribution is via the ``setup.py`` script::
+
+    python setup.py install
+
+Community
+=========
+
+Dogpile is developed by `Mike Bayer <http://techspot.zzzeek.org>`_, and is 
+loosely associated with the `Pylons Project <http://www.pylonsproject.org/>`_.
+As Dogpile's usage increases, it is anticipated that the Pylons mailing list and IRC channel
+will become the primary channels for support.
+
+Bugs
+====
+Bugs and feature enhancements to Dogpile should be reported on the `Bitbucket
+issue tracker
+<https://bitbucket.org/zzzeek/dogpile/issues?status=new&status=open>`_.  If you're not sure 
+that a particular issue is specific to either dogpile.cache or Dogpile, posting to the `dogpile.cache issue tracker <https://bitbucket.org/zzzeek/dogpile.cache/issues?status=new&status=open>`_
+is likely the better place to post first, but it's not critical either way.
+
+* `dogpile.cache issue tracker <https://bitbucket.org/zzzeek/dogpile.cache/issues?status=new&status=open>`_ (post here if unsure)
+* `dogpile issue tracker <https://bitbucket.org/zzzeek/dogpile/issues?status=new&status=open>`_
+

docs/build/index.rst

 .. toctree::
    :maxdepth: 2
 
+   front
    usage
    api
 

docs/build/usage.rst

-====================
-Dogpile Usage Guide
-====================
+===========
+Usage Guide
+===========
 
 At its core, Dogpile provides a locking interface around a "value creation" function.
 
 we approach how a fully featured caching system might be constructed around
 Dogpile.
 
-Note that when using the `dogpile.cache <http://bitbucket.org/zzzeek/dogpile.cache>`_
-package, the constructs here provide the internal implementation for that system,
-and users of that system don't need to access these APIs directly (though understanding
-the general patterns is a terrific idea in any case).
+Do I Need to Learn Dogpile's API Directly?
+==========================================
+
+It's anticipated that most users of Dogpile will be using it indirectly via the
+`dogpile.cache <http://bitbucket.org/zzzeek/dogpile.cache>`_ caching
+front-end.  If you fall into this category, then the short answer is no.
+
+Dogpile provides core internals to the 
+`dogpile.cache <http://bitbucket.org/zzzeek/dogpile.cache>`_
+package, which provides a simple-to-use caching API, rudimental
+backends for Memcached and others, and easy hooks to add new backends.  
+Users of dogpile.cache
+don't need to know or access Dogpile's APIs directly, though a rough understanding
+the general idea is always helpful.
+
 Using the core Dogpile APIs described here directly implies you're building your own 
 resource-usage system outside, or in addition to, the one 
 `dogpile.cache <http://bitbucket.org/zzzeek/dogpile.cache>`_ provides.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.