Add support for supplements, convert intro text to use this.

[wizard.git] / doc / create.rst

diff --git a/doc/repository-conversion.rst b/doc/create.rst
similarity index 93%
rename from doc/repository-conversion.rst
rename to doc/create.rst
index b770aedc8a64b178cef33056a8831fe4d539da02..cea861ed9c102a66eb6b193a152d8bbad8b69aee 100644 (file)
--- a/doc/repository-conversion.rst
+++ b/doc/create.rst
@@ -1,29 +1,32 @@
-Repository conversion
+Creating a repository
 =====================
 
 .. highlight:: sh
 
-One of Wizard's goals is to replace the previous autoinstaller infrastructure.
-Pre-wizard autoinstalls live in :file:`/mit/scripts/deploy` and consist of a
-tarball from upstream, possibly a scripts patch, and possibly some post-install
-munging (such as the creation of a :file:`php.ini` file and appropriate
-symlinks).
-
-Conversion to use Wizard involves placing :term:`pristine` versions of the source
-code (from the upstream tarballs) and appropriately patched scripts
-versions into a Git repository, as well as writing a :mod:`wizard.app`
-module for the application that implements application specific logic, such
-as how to install, upgrade or backup the installation.
-
-Here is a tutorial for performing a conversion, using Wordpress as
-an example.  We will implement only the functions necessary for installing
-an application--upgrades and backups are not described here.
-
-.. todo::
-
-    This guide duplicates a lot of what would be covered if you were
-    discussing how to create a new application from scratch.  Those
-    bits should be separated out and put in their own document.
+Adding Wizard support for a web application requires some glue code
+and a specially prepared repository.  Creating a new repository for an
+application in Wizard involves placing :term:`pristine` versions of the source
+code (from the upstream tarballs) and appropriately patched scripts versions
+into a Git repository, as well as writing a :mod:`wizard.app` module for the
+application that implements application specific logic, such as how to install,
+upgrade or backup the installation.
+
+Here is a tutorial for creating such a repository, using an old version of
+Wordpress as an example.  We will implement only the functions necessary for
+installing an application--upgrades and backups are not described here.
+
+.. supplement:: Conversions
+
+    One of Wizard's goals is to replace the previous autoinstaller infrastructure.
+    These boxes will explain extra steps that you must perform in order to carry
+    out a conversion of old-style autoinstalls to a Wizard autoinstall.
+    In brief, pre-wizard autoinstalls live in :file:`/mit/scripts/deploy` and
+    consist of a tarball from upstream, possibly a scripts patch, and possibly
+    some post-install munging (such as the creation of a :file:`php.ini` file
+    and appropriate symlinks).  Performing a conversion means that we will
+    recreate these changes in our Wizard autoinstall, and you will start you
+    repository with the *earliest* version of the application extant on our
+    servers.
 
 Setup
 -----