commit zephyrs for wiki.git exist
[wiki.git] / projects / www.mdwn
index 55544d81a3601f7f1c4103c6a82cd54c99c90336..61b1c00604b4a708b307ab0b092b41bfb39dece8 100644 (file)
@@ -4,20 +4,15 @@
 ## Design
 
 * The design is equivalent to the old design, just with the design trends of the current time (alternatively, built in the 21st century, but without sufficient design clue)
-* Too much wasted space on the left side
-* Too much wasted space on the top
-* Too grey
-* Blocks of color are gratuitous and jarring
-* Gradients are gratuitous
-* A design that could be reused for other websites with minor color tweaking would be nice (like the Debathena stylesheet)
+* What do we put on the right side?
 * Rectangles and straight lines make it look angular and stark
-* The design is too generic; needs more SIPB personality, so that another website couldn't just be swapped in
+* The design is too generic; needs more SIPB personality, so that another website couldn't just be swapped in (Define SIPB personality)
 * Consider rebranding possibilities (e.g. making fuzzball more "internal" like octocat on github, developing new logos, etc.) (publicity opportunities)
 
 ## Todo
 
 * git push (scripts-git, or gitosis on an XVM)
-* commit zephyrs for git (wiki.git and ikiwiki.git)
+* commit zephyrs for git (ikiwiki.git)
 * breadcrumbs style
 * make style usable for other SIPB sites?
 * make title == alt on images
 * migrate sipb.mit.edu/doc
 * usability tests
 
+### Done
+* add a grumpy fuzzball favicon to replace the ikiwiki one.
+  * feel free to make a better one if you like ~fawkes
+* all those other things we did before putting our todo here...
+
 ## 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 its 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 its on ports 80, (443?), or 444 it gets passed off to scripts (where it's handled by b-m or b-k, whichever).
 
-vhost configuration on scripts looks in ~~sipb-ww/web_scripts and checks the .htaccess file:
+scripts has a special vhost config (/etc/httpd/vhost.d/sipb.conf) for
+sipb.mit.edu:
 
-    if request is for /rtfm.html,
-        pass through
-    if request is for /iap pass of to stuff/iap 
-       (lives in /afs/athena.mit.edu/activity/s/sipb-iap/www/ of all place) 
-    if request if for /cgit, or /wiki 
-       pass through
-    else 
-       pass request for foo to wiki/foo, served from there
+        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.
 
-###For developments sake:
+###For development's sake:
 
 ####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/wiki.git", make your edits in the mdwn, etc.
 
-When you commit, ikiwiki should get automatically republished as HTML
+When you commit, ikiwiki should get automatically republished as HTML.
 
 
 ####Detailed Locker Layout
@@ -68,27 +70,27 @@ When you commit, ikiwiki should get automatically republished as HTML
     |   |-- ikiwiki: where some basic things are pulled from during build
     |   |-- locale: i18n things we aren't using
     |   `-- man: where the manpages really live
-    |-- ikiwiki: thing of it as like a mix of etc and build
+    |-- ikiwiki: think of it as like a mix of etc and build
     |   |-- cgitrc : configuration for cgit
     |   |-- ikiwiki.setup: configuration for ikiwiki
-    |   `-- src: where the git repo (wiki.git) is staged for building
+    |   `-- 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. 
+    |   |               variation on ikiwiki.
     |   `-- old.ikiwiki: irrelevant
     |-- web_scripts
-    |   |-- RCS: .htaccess mus be versioned
+    |   |-- RCS: .htaccess must be versioned
     |   |-- cgit: what you look at when you click on "History"
-    |   |-- doc: the old Trac Wiki
+    |   |-- 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 
+    |-- 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
+    `-- wiki.git: this is where all the content lives as markdown.
+                  Clone this if you hate web interfaces.