projects/www.mdwn

   1 [[!meta title="The SIPB Website"]]
   2 [[!toc ]]
   3
   4 ## Design
   5
   6 * 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)
   7 * Too much wasted space on the left side
   8 * Too much wasted space on the top
   9 * Too grey
  10 * Blocks of color are gratuitous and jarring
  11 * Gradients are gratuitous
  12 * A design that could be reused for other websites with minor color tweaking would be nice (like the Debathena stylesheet)
  13 * Rectangles and straight lines make it look angular and stark
  14 * The design is too generic; needs more SIPB personality, so that another website couldn't just be swapped in
  15 * Consider rebranding possibilities (e.g. making fuzzball more "internal" like octocat on github, developing new logos, etc.) (publicity opportunities)
  16
  17 ## Todo
  18
  19 * git push (scripts-git, or gitosis on an XVM)
  20 * commit zephyrs for git (wiki.git and ikiwiki.git)
  21 * breadcrumbs style
  22 * make style usable for other SIPB sites?
  23 * make title == alt on images
  24 * sipb-door widgets
  25 * other widgets
  26 * migrate sipb.mit.edu/doc
  27 * usability tests
  28
  29 ## How Things Work
  30
  31 (this is by fawkes's understanding, it may be wrong)
  32
  33 ###When a request comes in:
  34  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).
  35
  36 vhost configuration on scripts looks in ~~sipb-ww/web_scripts and checks the .htaccess file:
  37
  38     if request is for /rtfm.html,
  39         pass through
  40     if request is for /iap pass of to stuff/iap
  41        (lives in /afs/athena.mit.edu/activity/s/sipb-iap/www/ of all place)
  42     if request if for /cgit, or /wiki
  43        pass through
  44     else
  45        pass request for foo to wiki/foo, served from there
  46
  47
  48 ###For developments sake:
  49
  50 ####How Do I make edits?
  51 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.
  52
  53 When you commit, ikiwiki should get automatically republished as HTML
  54
  55
  56 ####Detailed Locker Layout
  57
  58     .
  59     |-- Scripts
  60     |   \-- writable: directory containing files writable by scripts
  61     |                 dotfiles such as .bash_history are symlinked here
  62     |-- arch
  63     |   \-- amd64_fedora9_scripts: binaries related to publishing ikiwiki
  64     |-- bin, lib, sbin: links into arch
  65     |-- man: a link into arch, ikiwiki manpages.
  66     |        add sipb-www to get them into MANPATH
  67     |-- share -> arch/amd64_fedora9_scripts/share
  68     |   |-- ikiwiki: where some basic things are pulled from during build
  69     |   |-- locale: i18n things we aren't using
  70     |   `-- man: where the manpages really live
  71     |-- ikiwiki: thing of it as like a mix of etc and build
  72     |   |-- cgitrc : configuration for cgit
  73     |   |-- ikiwiki.setup: configuration for ikiwiki
  74     |   `-- src: where the git repo (wiki.git) is staged for building
  75     |-- src
  76     |   |-- cgit: where cgit was built from (not actively changed)
  77     |   |-- ikiwiki.git: the git repository representing the SIPB
  78     |                   variation on ikiwiki.
  79     |   `-- old.ikiwiki: irrelevant
  80     |-- web_scripts
  81     |   |-- RCS: .htaccess mus be versioned
  82     |   |-- cgit: what you look at when you click on "History"
  83     |   |-- doc: the old Trac Wiki
  84     |   |-- iap -> /mit/sipb-iap/www
  85     |   |-- radiant: old and irrelevant
  86     |   |-- rtfm: contains an index.html identical to rtfm.html below
  87     |   |-- rtfm.html: served for rtfm.mit.edu:80
  88     |   `-- wiki: the published HTML that you are being served right now
  89     |-- web_scripts_tmp: old directory around to keep trac up-to-date. Should
  90     |                    vanish sooner or later
  91     `-- wiki.git: this is where all the content lives as markdown. Clone this
  92                    if you hate web interfaces
  93
  94