mention Chrome OS for Mosh for Chrome
[wiki.git] / projects / www.mdwn
index a428fc63a71c47f28626bef891b3274d05a1609c..9810dd2d1e6bd1f068491e9aefd4d04204a08118 100644 (file)
@@ -1,5 +1,5 @@
 [[!meta title="The SIPB Website"]]
-[[!toc ]]
+[[!toc]]
 
 ## Design
 
 
 ## 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.
@@ -32,23 +32,31 @@ exclusively for breadcrumbs ...
 
 
 ###When a request comes in:
- a connection comes in for sipb.mit.edu which via a hack in MIT DNS gets directed instead to PENGUIN-LUST.MIT.EDU. If its on ports 80, (443?), or 444 it gets passed off to scripts (where it's handled by b-m or b-k, whichever).
+ a connection comes in for sipb.mit.edu which via a hack in MIT DNS gets directed instead to PENGUIN-LUST.MIT.EDU. If it's on ports 80, (443?), or 444 it gets passed off to scripts (where it's handled by b-m or b-k, whichever).
 
 The DocumentRoot for sipb.mit.edu is `/afs/sipb.mit.edu/project/sipb-www/web_scripts/sipb`.  This directory contains a `.htaccess` file that causes most URIs to be served out of `web_scripts/sipb/_wiki`, a symlink to `../../Scripts/wiki`.  This directory's contents are static files generated by ikiwiki
 after each edit.
 
 ###For development's sake:
 
-####How Do I make edits?
+####How do I make edits?
 If you want to just edit contents, use the web interface (edit links at bottom of page) or "git clone git+ssh://sipb-www@scripts.mit.edu/mit/sipb-www/git/wiki", make your edits in the mdwn, etc.
 
 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