doc/index.rst

   1 Wizard
   2 ======
   3
   4 Wizard is the next-generation autoinstall management system.  It
   5 is currently being developed as an in-house tool for scripts.mit.edu,
   6 with a focus on automating the upgrading process using a Git backend.
   7
   8 Ultimately, we would like to see Wizard become a general purpose
   9 web application package manager, with first class support for a variety
  10 of applications under a homogenous interface.
  11
  12 Usage
  13 -----
  14
  15 .. highlight:: sh
  16
  17 Components of Wizard depend on packages and special configuration found
  18 on scripts servers.  As such, the best way to test Wizard is to SSH
  19 into a scripts server::
  20
  21     ssh scripts.mit.edu
  22     wizard help
  23
  24 Individual tools that are not scripts-specific, such as ``wizard upgrade``
  25 or ``wizard install``, can be run locally with Python 2.6 and a reasonably
  26 new version of Git.
  27
  28 .. highlight:: python
  29
  30 Development
  31 -----------
  32
  33 The canonical source of the Wizard source code is the directory
  34 :file:`/mit/scripts/git/wizard.git` on AFS.
  35
  36 The live version of the source code lives at :file:`/mit/scripts/wizard`
  37 and should be periodically updated as necessary (use the ``pull.sh`` script; you will
  38 need scripts-root bits to do so).  Documentation lives in
  39 :file:`/mit/scripts/web_scripts/home/wizard`; the post-merge
  40 hook on this Git repository should perform the appropriate rebuild.
  41
  42 Certain commands must be run as root on ``not-backward.mit.edu``
  43 due to our restrictive security policies.  This machine maintains
  44 its own copy of Wizard at :file:`/wizard`.  If you make local changes
  45 to this copy and would like to push them back to the core repository,
  46 you should push to a ``system:scripts-security-upd`` writable
  47 directory in your home directory, and then on a trusted machine
  48 perform the push to the canonical repository.
  49
  50 Table of Contents
  51 -----------------
  52
  53 .. toctree::
  54     :maxdepth: 1
  55
  56     setup
  57     repo
  58     create
  59     upgrade
  60     testing
  61     plugin
  62     glossary
  63     license
  64
  65 Modules
  66 -------
  67
  68 .. toctree::
  69     :maxdepth: 1
  70
  71     module/wizard
  72     module/wizard.app
  73     module/wizard.app.php
  74     module/wizard.deploy
  75     module/wizard.git
  76     module/wizard.install
  77     module/wizard.merge
  78     module/wizard.plugin
  79     module/wizard.prompt
  80     module/wizard.resolve
  81     module/wizard.shell
  82     module/wizard.sql
  83     module/wizard.sset
  84     module/wizard.tests
  85     module/wizard.user
  86     module/wizard.util
  87
  88 Indices and tables
  89 ------------------
  90
  91 * :ref:`genindex`
  92 * :ref:`modindex`
  93 * :ref:`search`
  94