add note about sending mail to lists

[wiki.git] / projects / www.mdwn

diff --git a/projects/www.mdwn b/projects/www.mdwn
index 2d8c2a78783d990766ebd119a0c363a2ebde2db5..45ffc19d382f309fe0754cb73394c3edcce1cc1a 100644 (file)
--- a/projects/www.mdwn
+++ b/projects/www.mdwn
@@ -1,5 +1,5 @@
 [[!meta title="The SIPB Website"]]
-[[!toc ]]
+[[!toc]]
 
 ## Design
 
@@ -11,17 +11,17 @@
 
 ## Todo
 
-* git push (scripts-git, or gitosis on an XVM)
 * make style usable for other SIPB sites?
 * make title == alt on images
 * sipb-door widgets
 * other widgets
-* migrate sipb.mit.edu/doc
 * usability tests
-* table of contents doesn't work. Likely to do with the co-opting of h1 
-exclusively for breadcrumbs ... 
 
 ### Done
+* table of contents doesn't work. Likely to do with the co-opting of h1 
+exclusively for breadcrumbs ... 
+* migrate sipb.mit.edu/doc
+* git push (scripts-git, or gitosis on an XVM)
 * commit zephyrs for git (ikiwiki.git)
 * breadcrumbs style
 * add a grumpy fuzzball favicon to replace the ikiwiki one.
@@ -46,9 +46,17 @@ When you commit, ikiwiki should get automatically republished as HTML.
 
 To work on the code surrounding the wiki in addition to the wikitext, clone the superrepo:
 
-    $ git clone git+ssh://sipb-www@scripts.mit.edu/mit/sipb-www/git/sipb-www
+    $ git clone --recursive ssh://sipb-www@scripts.mit.edu/mit/sipb-www/git/sipb-www
+    $ cd sipb-www
+
+You can also clone directly from the filesystem if you have AFS permission. If you want a preview of your pages to be generated locally, you can use the generate-preview.sh script in the superrepo:
+
+    $ git clone --recursive /mit/sipb-www/git/sipb-www
     $ cd sipb-www
-    $ git submodule update --init
+    $ # make changes here
+    $ mkdir /tmp/sipb-out
+    $ ./generate-preview.sh /tmp/sipb-out
+    $ firefox /tmp/sipb-out/index.html
 
 
 ####Detailed Locker Layout
@@ -77,6 +85,8 @@ To work on the code surrounding the wiki in addition to the wikitext, clone the
     |   |-- cgitrc : configuration for cgit
     |   |-- ikiwiki.setup: configuration for ikiwiki
     |   `-- src: where ikiwiki checks out wiki.git for building
+    |-- planet: Source code and templates for Planet SIPB
+    |   `-- sipb/basic: Our configuration
     |-- src
     |   \-- cgit: where cgit was built from (not actively changed)
     |-- web_scripts