X-Git-Url: https://sipb.mit.edu/gitweb.cgi/wiki.git/blobdiff_plain/b347c40cfa4b5ee3aaf4beaeab1e63cf12f85774..db62d260da47ae252472dc6dca5bbcc3ef19427b:/projects/www.mdwn

diff --git a/projects/www.mdwn b/projects/www.mdwn
index 8dd1b0b..5b8a777 100644
--- 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
-* editing pages adds lots of extra slashes to the path
 
 ### 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.
@@ -30,17 +30,16 @@
 
 ## How Things Work
 
-(this is by fawkes's understanding, it may be wrong)
 
 ###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).
 
-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 generated by ikiwiki
-after each edit, consisting of HTML files and a program ikiwiki.cgi.
+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.
@@ -51,14 +50,30 @@ To work on the code surrounding the wiki in addition to the wikitext, clone the
     $ cd sipb-www
     $ git submodule update --init
 
+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 /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
 
     .
     |-- Scripts
     |   |-- wiki: the published HTML that you are being served right now
+    |   |-- wiki-cgi: CGI scripts for the wiki
     |   \-- writable: directory containing files writable by scripts
     |                 dotfiles such as .bash_history are symlinked here
+    |-- git
+    |   |-- sipb-www.git: the master repo; other repos are submodules
+    |   |-- wiki.git: home of the wiki content as markdown, etc
+    |   \-- ikiwiki.git: the repo for SIPB's local variation on ikiwiki
+    |-- checkout: automatically updated checkout of sipb-www.git
     |-- arch
     |   \-- amd64_fedora9_scripts: binaries related to publishing ikiwiki
     |-- bin, lib, sbin: links into arch
@@ -72,23 +87,18 @@ 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)
-    |   |-- ikiwiki.git: the git repository representing the SIPB 
-    |   |               variation on ikiwiki.
-    |   `-- old.ikiwiki: irrelevant
+    |   \-- cgit: where cgit was built from (not actively changed)
     |-- web_scripts
-    |   |-- RCS: .htaccess must be versioned
     |   |-- cgit: what you look at when you click on "History"
     |   |-- doc: the old Trac wiki
     |   |-- radiant: old and irrelevant
     |   |-- rtfm: contains an index.html identical to rtfm.html below
-    |   |-- sipb: the document root for sipb.mit.edu
-    |   |   `-- _wiki -> ../../Scripts/wiki
-    |   `-- wiki -> ../Scripts/wiki
-    |-- web_scripts_tmp: old directory around to keep trac up-to-date. Should
-    |                    vanish sooner or later
-    `-- wiki.git: this is where all the content lives as markdown.
-                  Clone this if you hate web interfaces.
-
+    |   `-- sipb: the document root for sipb.mit.edu
+    |       |-- _wiki -> ../../Scripts/wiki
+    |       `-- _wiki-cgi -> ../../Scripts/wiki-cgi
+    \-- web_scripts_tmp: old directory around to keep trac up-to-date. Should
+                         vanish sooner or later