Clean up Mindterm docs a bit
[wiki.git] / projects / www.mdwn
index 51c8c58b9ac301da6f776fabff633deef5a354cf..e494524f86964473d7d9d79c39bc3f37ad8531dc 100644 (file)
@@ -1,57 +1,69 @@
 [[!meta title="The SIPB Website"]]
+[[!toc ]]
 
 ## 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)
-* breadcrumbs style
 * 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
+* commit zephyrs for git (ikiwiki.git)
+* breadcrumbs style
+* 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:
+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.
 
-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
+###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/git/wiki", make your edits in the mdwn, etc.
 
-###For developments sake:
+When you commit, ikiwiki should get automatically republished as HTML.
 
-####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.
+To work on the code surrounding the wiki in addition to the wikitext, clone the superrepo:
 
-When you commit, ikiwiki should get automatically republished as HTML
+    $ 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: was being used for scripts.git, currently unused
+    |-- 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
@@ -61,27 +73,22 @@ 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
+    |-- 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 mus be versioned
     |   |-- cgit: what you look at when you click on "History"
-    |   |-- doc: the old Trac Wiki
-    |   |-- iap -> /mit/sipb-iap/www
+    |   |-- doc: the old Trac wiki
     |   |-- 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