From: Mike Bayer <mike_mp@zzzcomputing.com>
Date: Mon, 21 Nov 2011 03:03:09 +0000 (-0500)
Subject: add front matter
X-Git-Tag: rel_0_1_0~46
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0124904dd2300caf03e1c2119f4169569a931138;p=thirdparty%2Fsqlalchemy%2Falembic.git

add front matter
---

diff --git a/docs/build/front.rst b/docs/build/front.rst
new file mode 100644
index 00000000..854e4759
--- /dev/null
+++ b/docs/build/front.rst
@@ -0,0 +1,45 @@
+============
+Front Matter
+============
+
+Information about the Alembic project.
+
+Project Homepage
+================
+
+Alembic is hosted on `Bitbucket <http://bitbucket.org>`_ - the lead project page is at https://bitbucket.org/zzzeek/alembic.  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/alembic.
+
+The most recent published version of this documentation should be at http://packages.python.org/alembic/.
+
+.. _installation:
+
+Installation
+============
+
+Install released versions of Alembic from the Python package index with `pip <http://pypi.python.org/pypi/pip>`_ or a similar tool::
+
+    pip install alembic
+
+Installation via source distribution is via the ``setup.py`` script::
+
+    python setup.py install
+
+The install will add the ``alembic`` command to the environment.  All operations with Alembic
+then proceed through the usage of this command.
+
+Community
+=========
+
+Alembic is developed by `Mike Bayer <http://techspot.zzzeek.org>`_, and is 
+loosely associated with the `SQLAlchemy <http://www.sqlalchemy.org/>`_ and `Pylons <http://www.pylonsproject.org>`_
+projects. 
+As Alembic's usage increases, it is anticipated that the SQLAlchemy mailing list and IRC channel
+will become the primary channels for support.
+
+Bugs
+====
+Bugs and feature enhancements to Alembic should be reported on the `Bitbucket
+issue tracker <https://bitbucket.org/zzzeek/alembic/issues?status=new&status=open>`_.  
diff --git a/docs/build/index.rst b/docs/build/index.rst
index 4ff3820f..596e7832 100644
--- a/docs/build/index.rst
+++ b/docs/build/index.rst
@@ -8,6 +8,7 @@ with the `SQLAlchemy <http://www.sqlalchemy.org>`_ Database Toolkit for Python.
 .. toctree::
    :maxdepth: 2
 
+   front
    tutorial
    ops
    api
diff --git a/docs/build/tutorial.rst b/docs/build/tutorial.rst
index 2b2eb639..470adb49 100644
--- a/docs/build/tutorial.rst
+++ b/docs/build/tutorial.rst
@@ -6,15 +6,7 @@ Tutorial
 scripts for a relational database, using `SQLAlchemy <http://www.sqlalchemy.org>`_ as the underlying engine.
 This tutorial will provide a full introduction to the theory and usage of this tool.
 
-Installation
-============
-
-Install Alembic with `pip <http://pypi.python.org/pypi/pip>`_ or a similar tool::
-
-    pip install alembic
-
-The install will add the ``alembic`` command to the environment.  All operations with Alembic
-then proceed through the usage of this command.
+To begin, make sure Alembic is installed as described at :ref:`installation`.
 
 The Migration Environment
 ==========================