X-Git-Url: https://scripts.mit.edu/gitweb/wizard.git/blobdiff_plain/8f1a8beb76b18a061ef825b58daf2187d1c6dec7..c4a68ce8e6a291ca66d2f73c7e3fdded87aa5f1f:/doc/index.rst diff --git a/doc/index.rst b/doc/index.rst index a5ba181..7d88a54 100644 --- 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,13 +19,12 @@ 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. You will, however, have to explicitly specify configuration -appropriate for your local machine. +new version of Git. .. highlight:: python @@ -33,7 +35,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,9 +52,14 @@ Table of Contents ----------------- .. toctree:: + :maxdepth: 1 + setup + repo + create + upgrade testing - repository-conversion + plugin glossary Modules @@ -62,11 +69,21 @@ Modules :maxdepth: 1 module/wizard + 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.util + module/wizard.sql module/wizard.sset + module/wizard.tests + module/wizard.util Indices and tables ------------------