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