Updated docs

docs/Makefile

@@ -3,16 +3,16 @@
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
-SPHINXBUILD = /Users/kimcheeleong/Projects/collective.exampledevtools/bin/zopepy /Users/kimcheeleong/Projects/collective.exampledevtools/bin/sphinx-build
+SPHINXBUILD = /Users/kimcheeleong/Projects/collective/collective.exampledevtools/bin/zopepy /Users/kimcheeleong/Projects/collective/collective.exampledevtools/bin/sphinx-build
 PAPER         =
-BUILDDIR      = /Users/kimcheeleong/Projects/collective.exampledevtools/docs
+BUILDDIR      = /Users/kimcheeleong/Projects/collective/collective.exampledevtools/docs
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/.doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) /Users/kimcheeleong/Projects/collective.exampledevtools/docs/
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) /Users/kimcheeleong/Projects/collective/collective.exampledevtools/docs/source
 # the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) /Users/kimcheeleong/Projects/collective.exampledevtools/docs/source
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) /Users/kimcheeleong/Projects/collective/collective.exampledevtools/docs/source
 
 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
 

docs/index.rst

@@ -2,30 +2,42 @@
 Example Plone Developement Tools
 ********************************
 
-.. topic:: Overview
+This package is created for the Plone Conf 2012 talk, Essential Development Tools. When developing a
+Plone product there are tools available which can ease development. This package will cover the technical
+aspects of the tools and how to apply them.
 
-    The :mod:`plone.api` is an elegant and simple API, built for humans wishing
-    to develop with Plone.
+This document will show how to use the tools by using examples. It isn't guaranteed that the information
+here is up-to-date fot the please read the Collective Developer Manual.
 
 
-This package is created for the Plone Conf 2012 talk, Essential Development Tools. When developing a
-Plone product there are tools available which can ease development.
+Setting up a project using templer (or paster)
+==============================================
+Templer is used for setting up Python eggs or buildouts. Paster is templers predecessor.
+
+.. topic:: To pip or not to pip
+    When installing templer via the pip installer it's possible that the installation of templer
+    and dependencies will fail. To circumvent this use easy_install instead, this installer
+    correctly installs templer and dependencies
+
+https://github.com/collective/ZopeSkel/issues/4
+
+This snipper shows how to install templer in a virtual environment:
 
+    .. code-block:: console
 
+        # virtualenv-2.7 templer-example
+        # cd templer-example/
+        # . ./bin/activate
+        # easy_install templer.plone templer.plone.localcommands
+        # templer --list
 
-Introduction
-============
 
-When developing a Plone product there are tools available which can ease development. This talk will explain which tools are available and how to use them.
 
-This egg is created for the Plone Conf 2012 talk, Essential Development Tools. When developing a Plone product
-  there are tools available which can ease development.
 
 Speed up buildout
 =================
 
 .. figure:: http://fschulze.github.com/mr.developer/xkcd-buildout.png
-    :figwidth: image
 
     Let Mr. Developer help you win the everlasting buildout battle!
 
@@ -42,16 +54,11 @@ Creating buildouts and products using paster or templer
 Manage development eggs with mr.developer
 =========================================
 
-.. figure:: http://fschulze.github.com/mr.developer/xkcd-buildout.png
-    :figwidth: image
-
-    Let Mr. Developer help you win the everlasting buildout battle!
-
-    (Remixed by Matt Hamilton, original from http://xkcd.com/303)
-
 Mr.developer helps with development eggs, auto-checkout and updating all eggs.
 Other tips and tricks
 
+http://pypi.python.org/pypi/mr.developer
+
 Automatically restart using sauna.reload
 ========================================
 
@@ -63,17 +70,20 @@ Use Omelette to create a unified directory structure of installed packaged
 and 'use the source (luke)' to search in Plone core packages
 
 
+Use plone.app.debugbar
+======================
+
 Dive into pdb when an error is raised using Products.PDBDebugMode
 =================================================================
 
+Do the PDB anywhere in your Plone site with Clouseau
+====================================================
+
 
 Debug a frozen instance using Products.signalstack
 ==================================================
 
 
-Do the PDB anywhere in your Plone site with Clouseau
-====================================================
-
 
 Ease the releasing of eggs with jarn.mkrelease or zest.mkrelease
 ================================================================