(1) There is no web_scripts/.htaccess anymore. (2) Screw RCS.
[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 * 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
23 ### Done
24 * commit zephyrs for git (ikiwiki.git)
25 * breadcrumbs style
26 * add a grumpy fuzzball favicon to replace the ikiwiki one.
27   * feel free to make a better one if you like ~fawkes
28 * all those other things we did before putting our todo here...
29
30 ## How Things Work
31
32 (this is by fawkes's understanding, it may be wrong)
33
34 ###When a request comes in:
35  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).
36
37 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
38 after each edit.
39
40 ###For development's sake:
41
42 ####How Do I make edits?
43 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.
44
45 When you commit, ikiwiki should get automatically republished as HTML.
46
47 To work on the code surrounding the wiki in addition to the wikitext, clone the superrepo:
48
49     $ git clone git+ssh://sipb-www@scripts.mit.edu/mit/sipb-www/git/sipb-www
50     $ cd sipb-www
51     $ git submodule update --init
52
53
54 ####Detailed Locker Layout
55
56     .
57     |-- Scripts
58     |   |-- wiki: the published HTML that you are being served right now
59     |   \-- writable: directory containing files writable by scripts
60     |                 dotfiles such as .bash_history are symlinked here
61     |-- arch
62     |   \-- amd64_fedora9_scripts: binaries related to publishing ikiwiki
63     |-- bin, lib, sbin: links into arch
64     |-- man: a link into arch, ikiwiki manpages. 
65     |        add sipb-www to get them into MANPATH
66     |-- share -> arch/amd64_fedora9_scripts/share
67     |   |-- ikiwiki: where some basic things are pulled from during build
68     |   |-- locale: i18n things we aren't using
69     |   `-- man: where the manpages really live
70     |-- ikiwiki: think of it as like a mix of etc and build
71     |   |-- cgitrc : configuration for cgit
72     |   |-- ikiwiki.setup: configuration for ikiwiki
73     |   `-- src: where ikiwiki checks out wiki.git for building
74     |-- src
75     |   |-- cgit: where cgit was built from (not actively changed)
76     |   |-- ikiwiki.git: the git repository representing the SIPB 
77     |   |               variation on ikiwiki.
78     |   `-- old.ikiwiki: irrelevant
79     |-- web_scripts
80     |   |-- cgit: what you look at when you click on "History"
81     |   |-- doc: the old Trac wiki
82     |   |-- radiant: old and irrelevant
83     |   |-- rtfm: contains an index.html identical to rtfm.html below
84     |   `-- sipb: the document root for sipb.mit.edu
85     |       `-- _wiki -> ../../Scripts/wiki
86     |-- web_scripts_tmp: old directory around to keep trac up-to-date. Should
87     |                    vanish sooner or later
88     `-- wiki.git: this is where all the content lives as markdown.
89                   Clone this if you hate web interfaces.
90
91