Handle Wordpress random keys correctly on install and upgrade.

[wizard.git] / doc / index.rst

diff --git a/doc/index.rst b/doc/index.rst
index 30f1e3f184a2da2d73c39ff57098e1b0422254f5..7d88a5449ebe7fc19a0357001bf16870d5d94848 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
 -----
@@ -16,33 +19,71 @@ on scripts servers.  As such, the best way to test Wizard is to SSH
 into a scripts server and add Wizard to your path::
 
     ssh scripts.mit.edu
-    export PATH="/mit/scripts/wizard/bin:$PATH"
+    add /mit/scripts/wizard/bin
     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.
+
 .. highlight:: python
 
 Development
 -----------
 
-You can retrieve a copy of the source code from AFS at
-:file:`/mit/scripts/git/wizard.git`
+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 (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.
+
+Certain commands must be run as root on ``not-backward.mit.edu``
+due to our restrictive security policies.  This machine maintains
+its own copy of Wizard at :file:`/wizard`.  If you make local changes
+to this copy and would like to push them back to the core repository,
+you should push to a ``system:scripts-security-upd`` writable
+directory in your home directory, and then on a trusted machine
+perform the push to the canonical repository.
 
 Table of Contents
 -----------------
 
 .. toctree::
-
-    repository-conversion
+    :maxdepth: 1
+
+    setup
+    repo
+    create
+    upgrade
+    testing
+    plugin
     glossary
 
 Modules
 -------
 
 .. toctree::
+    :maxdepth: 1
 
     module/wizard
-    module/wizard.util
+    module/wizard.app
+    module/wizard.app.php
+    module/wizard.cache
     module/wizard.deploy
+    module/wizard.git
+    module/wizard.install
+    module/wizard.merge
+    module/wizard.prompt
+    module/wizard.resolve
+    module/wizard.scripts
+    module/wizard.shell
+    module/wizard.sql
+    module/wizard.sset
+    module/wizard.tests
+    module/wizard.util
 
 Indices and tables
 ------------------
@@ -51,5 +92,3 @@ Indices and tables
 * :ref:`modindex`
 * :ref:`search`
 
-.. Hidden toctree to prevent Sphinx from complaining
-