]> sipb.mit.edu Git - ikiwiki.git/commitdiff
Add new instructions based on our new setup.
authorEdward Z. Yang <edwardzyang@thewritingpot.com>
Thu, 15 Jan 2009 08:18:30 +0000 (03:18 -0500)
committerQuentin Smith <quentin@mit.edu>
Thu, 15 Jan 2009 09:37:20 +0000 (04:37 -0500)
Signed-off-by: Edward Z. Yang <edwardzyang@thewritingpot.com>
README.SIPB

index 084a29251886ae35a3ffbd676f2d0f1cb6af2469..99882da7cf2738a2499f97ee3b4fed81de97d1e2 100644 (file)
@@ -4,25 +4,6 @@ Basic instructions on scripts of interest. Also,
 How this repository is set up, and how to keep IkiWiki up to date.
 
 
-Overview:
-
-IkiWiki is a compiler based wiki, as such the files you should be editing
-are not the live files, and you will need to run a script in order to make
-your changes live.  These scripts must be run as sipb-www@scripts.mit.edu,
-do not attempt to run them locally. The scripts are as follows:
-
-~/bin/reinstall-ikiwiki
-    This script reinstalls the source files (i.e. this directory) and must
-    be run if you edit source files or templates or anything else in this
-    directory.
-
-~/bin/update-ikiwiki
-    This script recompiles the website from its source directory
-    ikiwiki/src into the live wiki directory web_scripts/wiki.
-    It should be needed only if you do something odd; if you push
-    to the master repo at wiki.git, the post-update hook will do the
-    same thing as this.
-
 Setup:
 
 There are three branches of interest: remotes/origin/master, master
@@ -42,6 +23,9 @@ of rearchitecting and upstream cooperation.
 
 Keeping up to date:
 
+    XXX: This shouldn't be done anymore, as we now have a bare repository.
+    New instructions for syncing should be upcoming.
+
 This two-tiered setup means that you will need to rebase twice in order
 to propagate changes; possibly once if master == origin/master. Your
 commands will look like this:
@@ -58,3 +42,20 @@ $ git rebase master
 
 TODO: Make a script that does this.
 
+
+Scripts:
+
+The source repository has a hook that automatically deploys changes when
+you push to it.  If bad things happen, however, there are two scripts of
+interest:
+
+~/bin/reinstall-ikiwiki
+    This script runs make and make install, reinstalling the source files to
+    make it live.
+
+~/bin/update-ikiwiki
+    This script recompiles the website from its source directory
+    ikiwiki/src into the live wiki directory web_scripts/wiki.
+
+Normally, these don't need to be run.
+