“editing pages adds lots of extra slashes to the path” is fixed, I think.
[wiki.git] / projects / www.mdwn
index 33e00bb9c6d8a5cc2d07a7dd7e2e00e6c0bab176..a4cf452d815cdc2ac752a15d44c4a7082c281517 100644 (file)
@@ -1,21 +1,92 @@
-Design:
+[[!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
+* 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 (Define SIPB personality)
+* Consider rebranding possibilities (e.g. making fuzzball more "internal" like octocat on github, developing new logos, etc.) (publicity opportunities)
 
-Todo:
+## Todo
 
 * git push (scripts-git, or gitosis on an XVM)
-* commit zephyrs for git (wiki.git and ikiwiki.git)
-* breadcrumbs style
-* style for code blocks (see [[projects/sipb-afs-sync]])
 * 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
+
+### 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 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?
+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
+
+
+####Detailed Locker Layout
+
+    .
+    |-- Scripts
+    |   |-- wiki: the published HTML that you are being served right now
+    |   \-- writable: directory containing files writable by scripts
+    |                 dotfiles such as .bash_history are symlinked here
+    |-- arch
+    |   \-- amd64_fedora9_scripts: binaries related to publishing ikiwiki
+    |-- bin, lib, sbin: links into arch
+    |-- man: a link into arch, ikiwiki manpages. 
+    |        add sipb-www to get them into MANPATH
+    |-- share -> arch/amd64_fedora9_scripts/share
+    |   |-- ikiwiki: where some basic things are pulled from during build
+    |   |-- locale: i18n things we aren't using
+    |   `-- man: where the manpages really live
+    |-- ikiwiki: think of it as like a mix of etc and build
+    |   |-- cgitrc : configuration for cgit
+    |   |-- 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
+    |-- 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
+    |-- 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.
+
+