cut commented links to LennyBugs* -- now in projects/
[wiki.git] / projects / www.mdwn
index 6f2a3c8f93efbcce57a11478ec64296e24d1ba13..2d8c2a78783d990766ebd119a0c363a2ebde2db5 100644 (file)
@@ -18,6 +18,8 @@
 * 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
 * commit zephyrs for git (ikiwiki.git)
 
 ## 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).
 
-scripts has a special vhost config (/etc/httpd/vhost.d/sipb.conf) for
-sipb.mit.edu:
-
-        DocumentRoot /afs/sipb.mit.edu/project/sipb-www/web_scripts/wiki
-        Alias /doc /afs/sipb.mit.edu/project/sipb-www/web_scripts/doc
-        Alias /iap /afs/sipb.mit.edu/project/sipb-www/web_scripts/iap
-        Alias /cgit /afs/sipb.mit.edu/project/sipb-www/web_scripts/cgit
-        Alias /~sipb-www /afs/sipb.mit.edu/project/sipb-www/web_scripts
-
-For our purposes the key line is the first, meaning that URIs not
-falling into an exception are served straight out of
-web_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.
 
 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
-  $ cd sipb-www
-  $ git submodule update --init
+    $ git clone git+ssh://sipb-www@scripts.mit.edu/mit/sipb-www/git/sipb-www
+    $ cd sipb-www
+    $ git submodule update --init
 
 
 ####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
@@ -81,22 +78,15 @@ To work on the code surrounding the wiki in addition to the wikitext, clone the
     |   |-- ikiwiki.setup: configuration for ikiwiki
     |   `-- src: where ikiwiki checks out wiki.git for building
     |-- 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
-    |   |-- iap -> /mit/sipb-iap/www
     |   |-- radiant: old and irrelevant
     |   |-- rtfm: contains an index.html identical to rtfm.html below
-    |   |-- rtfm.html: served for rtfm.mit.edu:80
-    |   `-- wiki: the published HTML that you are being served right now
-    |-- 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