Set admin e-mail address properly on MediaWiki >= 1.18.0

[wizard.git] / doc / index.rst

diff --git a/doc/index.rst b/doc/index.rst
index 27632e7f9c2e6da494ca52ad41b2fb1f9f632aed..fa46ed3b93f769b433e0dff01858c8a81f58d0a5 100644 (file)
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -1,10 +1,13 @@
 Wizard
 ======
 
-Wizard is the next-generation autoinstall management service for
-scripts.mit.edu.  It's current focus is on automating the upgrading
-process using a Git backend, and in the future will administrate all
-aspects of autoinstalls (installation and upgrades).
+Wizard is the next-generation autoinstall management system.  It
+is currently being developed as an in-house tool for scripts.mit.edu,
+with a focus on automating the upgrading process using a Git backend.
+
+Ultimately, we would like to see Wizard become a general purpose
+web application package manager, with first class support for a variety
+of applications under a homogenous interface.
 
 Usage
 -----
@@ -13,16 +16,14 @@ Usage
 
 Components of Wizard depend on packages and special configuration found
 on scripts servers.  As such, the best way to test Wizard is to SSH
-into a scripts server and add Wizard to your path::
+into a scripts server::
 
     ssh scripts.mit.edu
-    export PATH="/mit/scripts/wizard/bin:$PATH"
     wizard help
 
 Individual tools that are not scripts-specific, such as ``wizard upgrade``
 or ``wizard install``, can be run locally with Python 2.6 and a reasonably
-new version of Git.  You will, however, have to explicitly specify configuration
-appropriate for your local machine.
+new version of Git.
 
 .. highlight:: python
 
@@ -33,7 +34,7 @@ The canonical source of the Wizard source code is the directory
 :file:`/mit/scripts/git/wizard.git` on AFS.
 
 The live version of the source code lives at :file:`/mit/scripts/wizard`
-and should be periodically updated as necessary (you will
+and should be periodically updated as necessary (use the ``pull.sh`` script; you will
 need scripts-root bits to do so).  Documentation lives in
 :file:`/mit/scripts/web_scripts/home/wizard`; the post-merge
 hook on this Git repository should perform the appropriate rebuild.
@@ -50,10 +51,16 @@ Table of Contents
 -----------------
 
 .. toctree::
+    :maxdepth: 1
 
+    setup
+    repo
+    create
+    upgrade
     testing
-    repository-conversion
+    plugin
     glossary
+    license
 
 Modules
 -------
@@ -62,9 +69,20 @@ Modules
     :maxdepth: 1
 
     module/wizard
+    module/wizard.app
+    module/wizard.app.php
     module/wizard.deploy
+    module/wizard.git
     module/wizard.install
+    module/wizard.merge
+    module/wizard.plugin
+    module/wizard.prompt
+    module/wizard.resolve
     module/wizard.shell
+    module/wizard.sql
+    module/wizard.sset
+    module/wizard.tests
+    module/wizard.user
     module/wizard.util
 
 Indices and tables