Usage
-----
+.. highlight:: sh
+
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::
- $ ssh scripts.mit.edu
- $ export PATH="/mit/scripts/wizard/bin:$PATH"
- $ wizard help
+ 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.
+
+.. highlight:: python
Development
-----------
-You can retrieve a copy of the source code from AFS at::
+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.
- /mit/scripts/git/wizard.git
+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
+
+Modules
+-------
+
+.. toctree::
+ :maxdepth: 1
+
+ module/wizard
+ module/wizard.deploy
+ module/wizard.install
+ module/wizard.shell
+ module/wizard.util
+ module/wizard.sset
Indices and tables
------------------
* :ref:`modindex`
* :ref:`search`
-.. Hidden toctree to prevent Sphinx from complaining
-
-.. toctree::
- :hidden:
-
- module/wizard
-