From: Edward Z. Yang <ezyang@mit.edu>
Date: Tue, 28 Jul 2009 20:58:27 +0000 (-0400)
Subject: Update README and TODO.
X-Git-Url: https://scripts.mit.edu/gitweb/wizard.git/commitdiff_plain/2e5b70b9d9a09d3cdb7d1efa1c2b20650125e48f

Update README and TODO.

Signed-off-by: Edward Z. Yang <ezyang@mit.edu>
---

diff --git a/README b/README
index 717e89b..7382dfa 100644
--- a/README
+++ b/README
@@ -1,12 +1,7 @@
 Wizard is the new autoinstaller management system for
-scripts.mit.edu.  It resides in:
+scripts.mit.edu.  It resides on not-backward.mit.edu at:
 
-    /mit/scripts/wizard
-
-It runs out of the box with the binaries in bin/; try
-`bin/wizard help` for some ideas on what to do.
-Repositories for autoinstall applications should reside
-in srv/, but are not versioned here.
+    /wizard
 
 Developers, read on:
 
@@ -49,6 +44,27 @@ be browsed for a descriptive overview of what the command does
 internally.  Use helper functions liberally.  Place all error classes
 at the bottom.
 
+== 'app' package ==
+
+There is a certain amount of application specific code that
+needs to be written for each autoinstaller.  These go here.
+
+== Notes when fiddling with application repositories ==
+
+- 'git rebase -p -i' is your friend.  Use it to rewrite history!
+
+- The obvious scripts specific change that a new repository
+  will have are the patches, but you should also check the
+  autoinstall scripts if they do anything special.  In particular:
+
+    - If it's a PHP application, it's probably inserting a php.ini
+      file and creating symlinks to it.  Be sure to replace the
+      appropriate values with placeholders WIZARD_SESSIONNAME
+      and WIZARD_TMPDIR
+
+    - You will probably need to generate relevant configuration
+      files for each version
+
 == Design decisions ==
 
 - A mass tool will plow ahead even if the subcommand throws
diff --git a/TODO b/TODO
index f1da007..0cb9ebc 100644
--- a/TODO
+++ b/TODO
@@ -5,9 +5,6 @@ TODO NOW:
 - Better error message if daemon/scripts-security-upd
   is not on scripts-security-upd list
 
-- Put php.ini links in repos (probably will need another
-  script in .scripts)
-
 - Add repository flag to migrate so that we can specify an
   arbitrary repository to migrate to
 
@@ -19,7 +16,7 @@ TODO NOW:
 
 - The great initial deploy:
     - Turn on mediawiki new autoinstaller
-    - Migrate all mediawik installs
+    - Migrate all mediawiki installs
 
 - Consider making usermode wizard operation a support mode
   (mostly for letting users upgrade things themself)