]> scripts.mit.edu Git - wizard.git/blobdiff - doc/index.rst
Implement sqlite dict. We might not actually use this.
[wizard.git] / doc / index.rst
index 30f1e3f184a2da2d73c39ff57098e1b0422254f5..48f70383a94666f3ad5e386774ed99f80f128a9a 100644 (file)
@@ -19,19 +19,39 @@ into a scripts server and add Wizard to your path::
     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.
+
 .. 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 (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::
 
+    testing
     repository-conversion
     glossary
 
@@ -39,10 +59,15 @@ Modules
 -------
 
 .. toctree::
+    :maxdepth: 1
 
     module/wizard
-    module/wizard.util
+    module/wizard.cache
     module/wizard.deploy
+    module/wizard.install
+    module/wizard.shell
+    module/wizard.util
+    module/wizard.sset
 
 Indices and tables
 ------------------
@@ -51,5 +76,3 @@ Indices and tables
 * :ref:`modindex`
 * :ref:`search`
 
-.. Hidden toctree to prevent Sphinx from complaining
-