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 * What do we put on the right side?
   8 * Rectangles and straight lines make it look angular and stark
   9 * The design is too generic; needs more SIPB personality, so that another website couldn't just be swapped in (Define SIPB personality)
  10 * Consider rebranding possibilities (e.g. making fuzzball more "internal" like octocat on github, developing new logos, etc.) (publicity opportunities)
  11
  12 ## Todo
  13
  14 * git push (scripts-git, or gitosis on an XVM)
  15 * make style usable for other SIPB sites?
  16 * make title == alt on images
  17 * sipb-door widgets
  18 * other widgets
  19 * migrate sipb.mit.edu/doc
  20 * usability tests
  21 * table of contents doesn't work
  22 * editing pages adds lots of extra slashes to the path
  23
  24 ### Done
  25 * commit zephyrs for git (ikiwiki.git)
  26 * breadcrumbs style
  27 * add a grumpy fuzzball favicon to replace the ikiwiki one.
  28   * feel free to make a better one if you like ~fawkes
  29 * all those other things we did before putting our todo here...
  30
  31 ## How Things Work
  32
  33 (this is by fawkes's understanding, it may be wrong)
  34
  35 ###When a request comes in:
  36  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).
  37
  38 scripts has a special vhost config (/etc/httpd/vhost.d/sipb.conf) for
  39 sipb.mit.edu:
  40
  41         DocumentRoot /afs/sipb.mit.edu/project/sipb-www/web_scripts/wiki
  42         Alias /doc /afs/sipb.mit.edu/project/sipb-www/web_scripts/doc
  43         Alias /iap /afs/sipb.mit.edu/project/sipb-www/web_scripts/iap
  44         Alias /cgit /afs/sipb.mit.edu/project/sipb-www/web_scripts/cgit
  45         Alias /~sipb-www /afs/sipb.mit.edu/project/sipb-www/web_scripts
  46
  47 For our purposes the key line is the first, meaning that URIs not
  48 falling into an exception are served straight out of
  49 web_scripts/wiki/.  This directory's contents are generated by ikiwiki
  50 after each edit, consisting of HTML files and a program ikiwiki.cgi.
  51
  52 ###For development's sake:
  53
  54 ####How Do I make edits?
  55 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.
  56
  57 When you commit, ikiwiki should get automatically republished as HTML.
  58
  59 To work on the code surrounding the wiki in addition to the wikitext, clone the superrepo:
  60
  61     $ git clone git+ssh://sipb-www@scripts.mit.edu/mit/sipb-www/git/sipb-www
  62     $ cd sipb-www
  63     $ git submodule update --init
  64
  65
  66 ####Detailed Locker Layout
  67
  68     .
  69     |-- Scripts
  70     |   \-- writable: directory containing files writable by scripts
  71     |                 dotfiles such as .bash_history are symlinked here
  72     |-- arch
  73     |   \-- amd64_fedora9_scripts: binaries related to publishing ikiwiki
  74     |-- bin, lib, sbin: links into arch
  75     |-- man: a link into arch, ikiwiki manpages.
  76     |        add sipb-www to get them into MANPATH
  77     |-- share -> arch/amd64_fedora9_scripts/share
  78     |   |-- ikiwiki: where some basic things are pulled from during build
  79     |   |-- locale: i18n things we aren't using
  80     |   `-- man: where the manpages really live
  81     |-- ikiwiki: think of it as like a mix of etc and build
  82     |   |-- cgitrc : configuration for cgit
  83     |   |-- ikiwiki.setup: configuration for ikiwiki
  84     |   `-- src: where ikiwiki checks out wiki.git for building
  85     |-- src
  86     |   |-- cgit: where cgit was built from (not actively changed)
  87     |   |-- ikiwiki.git: the git repository representing the SIPB
  88     |   |               variation on ikiwiki.
  89     |   `-- old.ikiwiki: irrelevant
  90     |-- web_scripts
  91     |   |-- RCS: .htaccess must be versioned
  92     |   |-- cgit: what you look at when you click on "History"
  93     |   |-- doc: the old Trac wiki
  94     |   |-- iap -> /mit/sipb-iap/www
  95     |   |-- radiant: old and irrelevant
  96     |   |-- rtfm: contains an index.html identical to rtfm.html below
  97     |   |-- rtfm.html: served for rtfm.mit.edu:80
  98     |   `-- wiki: the published HTML that you are being served right now
  99     |-- web_scripts_tmp: old directory around to keep trac up-to-date. Should
 100     |                    vanish sooner or later
 101     `-- wiki.git: this is where all the content lives as markdown.
 102                   Clone this if you hate web interfaces.
 103
 104