From: Edward Z. Yang <ezyang@mit.edu>
Date: Mon, 3 May 2010 23:14:19 +0000 (-0400)
Subject: Add information about Scripts specific code in Wizard.
X-Git-Url: https://scripts.mit.edu/gitweb/wizard.git/commitdiff_plain/00d95041e6535d1e1195222c8f805d8207e8caef

Add information about Scripts specific code in Wizard.

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

diff --git a/SCRIPTS b/SCRIPTS
new file mode 100644
index 0000000..59f1fc9
--- /dev/null
+++ b/SCRIPTS
@@ -0,0 +1,32 @@
+Wizard and Scripts
+------------------
+
+We'd like Wizard to be sufficiently general so as to not work
+on Scripts. To some degree, it already is; Wizard can be easily
+set up in a development type environment on a non-Scripts server.
+
+Here documents Scripts specific code inside Wizard that should
+be moved away:
+
+    * wizard.scripts is the location that all Scripts specific code
+      will eventually live.
+
+    * wizard.sql does a Script's specific call to get SQL information
+      if no SQL credentials are explicitly passed.
+
+    * In wizard.util
+        - get_dir_owner performs a PTS query if normal pwd querying
+          fails
+        - get_operator_name_from_gssapi requires a patch to SSH that
+          we patched support for
+        - get_operator_info consults Hesiod for more information based
+          on a username.
+        - set_author_env guesses emails using scripts.mit.edu addresses
+
+    * wizard.install contains strategies for guessing variables
+      for an installation that are Scripts specific
+
+    * The mass-* commands are especially designed for Scripts, so while
+      they're ostensibly portable, they'd probably need a bit of working
+      to be easy-to-use for other people.  They also rely on a "versions"
+      directory whose code exists independently of Wizard.