1. Matthew Scott
  2. slipper

Commits

Matthew Scott  committed d84f521

Rename docs to doc; symmetry with Schevo and UNIX

  • Participants
  • Parent commits c8d5114
  • Branches default

Comments (0)

Files changed (6)

File doc/index.txt

View file
  • Ignore whitespace
+=========
+ Slipper
+=========
+
+----------------------------------
+ Python slippers for your website
+----------------------------------
+
+Slipper lets you host a nice-looking website directly from a Mercurial
+repository, using reStructuredText for markup.
+
+
+Is that so?
+===========
+
+It sure is!
+
+If you're a fan of Mercurial_, really like reStructuredText_, and want to
+create a static website with a dynamic history, you might like using
+Slipper.
+
+.. _Mercurial: http://selenic.com/mercurial/
+.. _reStructuredText: http://docutils.sf.net/rst.html
+
+
+Who uses it?
+============
+
+* `Slipper <http://getschevo.org/slipper/`__ (of course!)
+* `Get Schevo <http://getschevo.org/>`__
+
+
+How do I install it...
+======================
+
+* `... on Webfaction? <webfaction.txt>`__
+
+
+Community
+=========
+
+* Mercurial repositories:
+
+  - `<https://getschevo.org/hg/slipper-open>`__: open to all contributions.
+    Post request to mailing list with desired username and we'll email you
+    a random password.
+
+* `python-slipper@googlegroups.com
+  <http://groups.google.com/group/python-slipper>`__
+
+* Shared `<todo.txt>`__.
+
+
+What do Python slippers look like?
+==================================
+
+Python slippers are not made of actual Python.  They are soft, plush, and
+keep your feet warm in the winter.  If you wind up drawing some, add it to a
+clone of `this site's repository
+<https://getschevo.org/hg/slipper-open/>`__, spruce up this page, <and `post
+your bundle
+<http://groups.google.com/group/python-slipper/files?upload=1>`__.
+
+
+Legal
+=====
+
+Copyright 2008 by `Matthew R. Scott <mailto:gldnspud@gmail.com>`__.
+
+License: `MIT <http://en.wikipedia.org/wiki/MIT_license>`__.
+

File doc/todo.txt

View file
  • Ignore whitespace
+=========
+ Slipper
+=========
+
+------
+ Todo
+------
+
+
+Cosmetic
+========
+
+* Decent lightweight CSS for the site.
+
+* Stop embedding it in each page!
+
+* Whatever it takes to make `this <http://getschevo.org/>`__ look like `this
+  mockup
+  <http://getschevo.org/hg/getschevo-open/raw-file/tip/mockup/index.html>`__.
+
+
+Security
+========
+
+* Heed `David Goodger's advice about deploying Docutils securely
+  <http://docutils.sourceforge.net/docs/howto/security.html>`__.
+
+
+Performance
+===========
+
+* Turn it into a full-fledged WSGI app and run it as a long-running process
+  instead of a CGI script.
+
+* Make sure we take advantage of HTTP headers to avoid work when
+  the client already has a copy of the requested file.
+

File doc/webfaction.txt

View file
  • Ignore whitespace
+==================================
+ Installing Slipper on Webfaction
+==================================
+
+
+This HOWTO assumes that you are logged into your `Webfaction
+<http://webfaction.com>`__ account.
+
+
+Install virtualenv
+------------------
+
+`virtualenv <http://pypi.python.org/pypi/virtualenv/>`__ is a wonderful tool
+for isolating Python instances and dependencies.
+
+Install it for Python 2.5::
+    
+    $ easy_install-2.5 -d $HOME/lib/python2.5 -s $HOME/bin virtualenv
+
+
+Create an environment for Slipper
+---------------------------------
+
+Creating a new environment is easy::
+    
+    $ cd ~
+    $ virtualenv slipper.env
+
+
+Install Slipper
+---------------
+
+Any commands run within the environment's `bin` directory run within the
+virtual environment.
+
+Install or upgrade it directly from the repository::
+    
+    $ slipper.env/bin/easy_install -U \
+      http://getschevo.org/hg/slipper-open/archive/tip.tar.gz
+
+
+Install Mercurial
+-----------------
+
+It's useful to just install Mercurial within the virtual environment, so we
+know that `Slipper` is always working with the same version.
+
+We need to do this manually, since Mercurial cannot be installed using
+`easy_install`::
+    
+    $ source slipper.env/bin/activate
+    (slipper.env)$ mkdir slipper.env/src
+    (slipper.env)$ cd slipper.env/src
+    (slipper.env)$ easy_install -eb. Mercurial
+    (slipper.env)$ cd mercurial
+    (slipper.env)$ python2.5 setup.py install
+    (slipper.env)$ which hg
+    ~/slipper.env/bin/hg
+
+
+Set up objects in Webfaction control panel
+------------------------------------------
+
+Create a new `Static/CGI/PHP` app to host your `Slipper` configuration
+files, such as `my_slipper`.
+
+Mount the app on the website and make note of the mount point.
+
+
+Prepare the directory for CGI
+-----------------------------
+
+Protect the directory of your configuration files::
+    
+    $ cd ~/webapps/my_slipper
+    $ rm index.html
+    $ chmod 0711 .
+
+
+Create configuration files
+--------------------------
+
+Let's say you want to host this repository at the root of
+``http://mysite.com/``:
+
+* It's located on disk at ``/home2/myusername/hg/myapp-dev``
+
+* You use the ``.txt`` file extension to tag reStructuredText documents.
+
+* You want to serve the ``docs/`` directory within the repository as the
+  root of the site.
+
+* You want to serve the ``tip`` revision.
+
+* You have a `hgweb` or `hgwebdir` presenting the repository at
+  ``http://mysite.com/hg/myapp-dev/``.
+
+Create a configuration file, such as ``slipper.cgi``, and place it in the
+directory of the web app you created, such as
+``/home2/myusername/webapps/my_slipper``. Make it look like this, except
+make the first two lines below all one line::
+    
+    #!/home2/myusername/slipper.env/bin/python2.5
+      /home2/myusername/slipper.env/bin/slipper_cgi
+
+    [global]
+    cache = /home2/myusername/slipper.env/cache
+    rst_extension = .txt
+
+    [dev]
+    hg_repos = /home2/myusername/hg/myapp-dev
+    hgweb_url = http://mysite.com/hg/myapp-dev
+
+.. note::
+
+    The `rst_extension` setting may be set globally, and it may also be
+    overridden in each section.  The default, if nothing is specified, is to
+    use ``.rst``.
+
+Make the file executable and create the cache::
+    
+    $ chmod 711 slipper.cgi
+    $ mkdir ~/slipper.env/cache
+
+Verify that it worked by visiting
+``http://mysite.com/myapp.cgi?dev/tip/index.html``. You should see the index
+page of your site.
+
+Now make that available as ``http://mysite.com/`` and make other resources
+available as well by adding to ``.htaccess``::
+    
+    RewriteEngine On
+    RewriteBase /
+
+    RewriteRule ^$ slipper.cgi?dev/tip/docs/index.txt [L]
+    
+    RewriteCond %{REQUEST_FILENAME} !-f
+    RewriteCond %{REQUEST_FILENAME} !-d
+    RewriteRule ^(.*)$ slipper.cgi?dev/tip/docs/$1 [L]
+
+.. note::
+
+    If your `my_slipper` Webfaction app is mounted on your site at a
+    location other than ``/``, be sure to set `RewriteBase` to that point
+    rather than ``/`` as shown in these examples.
+
+To make available specific versions, add some more rules, paying attention
+to proper ordering (since they are evaluated sequentially)::
+    
+    RewriteEngine On
+    RewriteBase /
+
+    RewriteRule ^$ slipper.cgi?dev/tip/docs/index.txt [L]
+    
+    RewriteCond %{REQUEST_FILENAME} !-f
+    RewriteCond %{REQUEST_FILENAME} !-d
+    RewriteRule ^v/([^/]*)/(.*)$ slipper.cgi?dev/$1/docs/$2 [L]
+
+    RewriteCond %{REQUEST_FILENAME} !-f
+    RewriteCond %{REQUEST_FILENAME} !-d
+    RewriteRule ^(.*)$ slipper.cgi?dev/tip/docs/$1 [L]
+

File docs/index.txt

  • Ignore whitespace
-=========
- Slipper
-=========
-
-----------------------------------
- Python slippers for your website
-----------------------------------
-
-Slipper lets you host a nice-looking website directly from a Mercurial
-repository, using reStructuredText for markup.
-
-
-Is that so?
-===========
-
-It sure is!
-
-If you're a fan of Mercurial_, really like reStructuredText_, and want to
-create a static website with a dynamic history, you might like using
-Slipper.
-
-.. _Mercurial: http://selenic.com/mercurial/
-.. _reStructuredText: http://docutils.sf.net/rst.html
-
-
-Who uses it?
-============
-
-* `Slipper <http://getschevo.org/slipper/`__ (of course!)
-* `Get Schevo <http://getschevo.org/>`__
-
-
-How do I install it...
-======================
-
-* `... on Webfaction? <webfaction.txt>`__
-
-
-Community
-=========
-
-* Mercurial repositories:
-
-  - `<https://getschevo.org/hg/slipper-open>`__: open to all contributions.
-    Post request to mailing list with desired username and we'll email you
-    a random password.
-
-* `python-slipper@googlegroups.com
-  <http://groups.google.com/group/python-slipper>`__
-
-* Shared `<todo.txt>`__.
-
-
-What do Python slippers look like?
-==================================
-
-Python slippers are not made of actual Python.  They are soft, plush, and
-keep your feet warm in the winter.  If you wind up drawing some, add it to a
-clone of `this site's repository
-<https://getschevo.org/hg/slipper-open/>`__, spruce up this page, <and `post
-your bundle
-<http://groups.google.com/group/python-slipper/files?upload=1>`__.
-
-
-Legal
-=====
-
-Copyright 2008 by `Matthew R. Scott <mailto:gldnspud@gmail.com>`__.
-
-License: `MIT <http://en.wikipedia.org/wiki/MIT_license>`__.
-

File docs/todo.txt

  • Ignore whitespace
-=========
- Slipper
-=========
-
-------
- Todo
-------
-
-
-Cosmetic
-========
-
-* Decent lightweight CSS for the site.
-
-* Stop embedding it in each page!
-
-* Whatever it takes to make `this <http://getschevo.org/>`__ look like `this
-  mockup
-  <http://getschevo.org/hg/getschevo-open/raw-file/tip/mockup/index.html>`__.
-
-
-Security
-========
-
-* Heed `David Goodger's advice about deploying Docutils securely
-  <http://docutils.sourceforge.net/docs/howto/security.html>`__.
-
-
-Performance
-===========
-
-* Turn it into a full-fledged WSGI app and run it as a long-running process
-  instead of a CGI script.
-
-* Make sure we take advantage of HTTP headers to avoid work when
-  the client already has a copy of the requested file.
-

File docs/webfaction.txt

  • Ignore whitespace
-==================================
- Installing Slipper on Webfaction
-==================================
-
-
-This HOWTO assumes that you are logged into your `Webfaction
-<http://webfaction.com>`__ account.
-
-
-Install virtualenv
-------------------
-
-`virtualenv <http://pypi.python.org/pypi/virtualenv/>`__ is a wonderful tool
-for isolating Python instances and dependencies.
-
-Install it for Python 2.5::
-    
-    $ easy_install-2.5 -d $HOME/lib/python2.5 -s $HOME/bin virtualenv
-
-
-Create an environment for Slipper
----------------------------------
-
-Creating a new environment is easy::
-    
-    $ cd ~
-    $ virtualenv slipper.env
-
-
-Install Slipper
----------------
-
-Any commands run within the environment's `bin` directory run within the
-virtual environment.
-
-Install or upgrade it directly from the repository::
-    
-    $ slipper.env/bin/easy_install -U \
-      http://getschevo.org/hg/slipper-open/archive/tip.tar.gz
-
-
-Install Mercurial
------------------
-
-It's useful to just install Mercurial within the virtual environment, so we
-know that `Slipper` is always working with the same version.
-
-We need to do this manually, since Mercurial cannot be installed using
-`easy_install`::
-    
-    $ source slipper.env/bin/activate
-    (slipper.env)$ mkdir slipper.env/src
-    (slipper.env)$ cd slipper.env/src
-    (slipper.env)$ easy_install -eb. Mercurial
-    (slipper.env)$ cd mercurial
-    (slipper.env)$ python2.5 setup.py install
-    (slipper.env)$ which hg
-    ~/slipper.env/bin/hg
-
-
-Set up objects in Webfaction control panel
-------------------------------------------
-
-Create a new `Static/CGI/PHP` app to host your `Slipper` configuration
-files, such as `my_slipper`.
-
-Mount the app on the website and make note of the mount point.
-
-
-Prepare the directory for CGI
------------------------------
-
-Protect the directory of your configuration files::
-    
-    $ cd ~/webapps/my_slipper
-    $ rm index.html
-    $ chmod 0711 .
-
-
-Create configuration files
---------------------------
-
-Let's say you want to host this repository at the root of
-``http://mysite.com/``:
-
-* It's located on disk at ``/home2/myusername/hg/myapp-dev``
-
-* You use the ``.txt`` file extension to tag reStructuredText documents.
-
-* You want to serve the ``docs/`` directory within the repository as the
-  root of the site.
-
-* You want to serve the ``tip`` revision.
-
-* You have a `hgweb` or `hgwebdir` presenting the repository at
-  ``http://mysite.com/hg/myapp-dev/``.
-
-Create a configuration file, such as ``slipper.cgi``, and place it in the
-directory of the web app you created, such as
-``/home2/myusername/webapps/my_slipper``. Make it look like this, except
-make the first two lines below all one line::
-    
-    #!/home2/myusername/slipper.env/bin/python2.5
-      /home2/myusername/slipper.env/bin/slipper_cgi
-
-    [global]
-    cache = /home2/myusername/slipper.env/cache
-    rst_extension = .txt
-
-    [dev]
-    hg_repos = /home2/myusername/hg/myapp-dev
-    hgweb_url = http://mysite.com/hg/myapp-dev
-
-.. note::
-
-    The `rst_extension` setting may be set globally, and it may also be
-    overridden in each section.  The default, if nothing is specified, is to
-    use ``.rst``.
-
-Make the file executable and create the cache::
-    
-    $ chmod 711 slipper.cgi
-    $ mkdir ~/slipper.env/cache
-
-Verify that it worked by visiting
-``http://mysite.com/myapp.cgi?dev/tip/index.html``. You should see the index
-page of your site.
-
-Now make that available as ``http://mysite.com/`` and make other resources
-available as well by adding to ``.htaccess``::
-    
-    RewriteEngine On
-    RewriteBase /
-
-    RewriteRule ^$ slipper.cgi?dev/tip/docs/index.txt [L]
-    
-    RewriteCond %{REQUEST_FILENAME} !-f
-    RewriteCond %{REQUEST_FILENAME} !-d
-    RewriteRule ^(.*)$ slipper.cgi?dev/tip/docs/$1 [L]
-
-.. note::
-
-    If your `my_slipper` Webfaction app is mounted on your site at a
-    location other than ``/``, be sure to set `RewriteBase` to that point
-    rather than ``/`` as shown in these examples.
-
-To make available specific versions, add some more rules, paying attention
-to proper ordering (since they are evaluated sequentially)::
-    
-    RewriteEngine On
-    RewriteBase /
-
-    RewriteRule ^$ slipper.cgi?dev/tip/docs/index.txt [L]
-    
-    RewriteCond %{REQUEST_FILENAME} !-f
-    RewriteCond %{REQUEST_FILENAME} !-d
-    RewriteRule ^v/([^/]*)/(.*)$ slipper.cgi?dev/$1/docs/$2 [L]
-
-    RewriteCond %{REQUEST_FILENAME} !-f
-    RewriteCond %{REQUEST_FILENAME} !-d
-    RewriteRule ^(.*)$ slipper.cgi?dev/tip/docs/$1 [L]
-