explain vhost config, which does the job .htaccess should ultimately do
[wiki.git] / 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 ### Done
30 * add a grumpy fuzzball favicon to replace the ikiwiki one.
31   * feel free to make a better one if you like ~fawkes
32 * all those other things we did before putting our todo here...
33
34 ## How Things Work
35
36 (this is by fawkes's understanding, it may be wrong)
37
38 ###When a request comes in:
39  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).
40
41 scripts has a special vhost config (/etc/httpd/vhost.d/sipb.conf) for
42 sipb.mit.edu:
43
44         DocumentRoot /afs/sipb.mit.edu/project/sipb-www/web_scripts/wiki
45         Alias /doc /afs/sipb.mit.edu/project/sipb-www/web_scripts/doc
46         Alias /iap /afs/sipb.mit.edu/project/sipb-www/web_scripts/iap
47         Alias /cgit /afs/sipb.mit.edu/project/sipb-www/web_scripts/cgit
48         Alias /~sipb-www /afs/sipb.mit.edu/project/sipb-www/web_scripts
49
50 For our purposes the key line is the first, meaning that URIs not
51 falling into an exception are served straight out of
52 web_scripts/wiki/.  This directory's contents are generated by ikiwiki
53 after each edit, consisting of HTML files and a program ikiwiki.cgi.
54
55 ###For development's sake:
56
57 ####How Do I make edits?
58 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.
59
60 When you commit, ikiwiki should get automatically republished as HTML.
61
62
63 ####Detailed Locker Layout
64
65     .
66     |-- Scripts
67     |   \-- writable: directory containing files writable by scripts
68     |                 dotfiles such as .bash_history are symlinked here
69     |-- arch
70     |   \-- amd64_fedora9_scripts: binaries related to publishing ikiwiki
71     |-- bin, lib, sbin: links into arch
72     |-- man: a link into arch, ikiwiki manpages. 
73     |        add sipb-www to get them into MANPATH
74     |-- share -> arch/amd64_fedora9_scripts/share
75     |   |-- ikiwiki: where some basic things are pulled from during build
76     |   |-- locale: i18n things we aren't using
77     |   `-- man: where the manpages really live
78     |-- ikiwiki: think of it as like a mix of etc and build
79     |   |-- cgitrc : configuration for cgit
80     |   |-- ikiwiki.setup: configuration for ikiwiki
81     |   `-- src: where ikiwiki checks out wiki.git for building
82     |-- src
83     |   |-- cgit: where cgit was built from (not actively changed)
84     |   |-- ikiwiki.git: the git repository representing the SIPB 
85     |   |               variation on ikiwiki.
86     |   `-- old.ikiwiki: irrelevant
87     |-- web_scripts
88     |   |-- RCS: .htaccess must be versioned
89     |   |-- cgit: what you look at when you click on "History"
90     |   |-- doc: the old Trac wiki
91     |   |-- iap -> /mit/sipb-iap/www
92     |   |-- radiant: old and irrelevant
93     |   |-- rtfm: contains an index.html identical to rtfm.html below
94     |   |-- rtfm.html: served for rtfm.mit.edu:80
95     |   `-- wiki: the published HTML that you are being served right now
96     |-- web_scripts_tmp: old directory around to keep trac up-to-date. Should
97     |                    vanish sooner or later
98     `-- wiki.git: this is where all the content lives as markdown.
99                   Clone this if you hate web interfaces.
100
101