Update the members page to reflect the new EC and full memebers
[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 * make style usable for other SIPB sites?
15 * make title == alt on images
16 * sipb-door widgets
17 * other widgets
18 * usability tests
19
20 ### Done
21 * table of contents doesn't work. Likely to do with the co-opting of h1 
22 exclusively for breadcrumbs ... 
23 * migrate sipb.mit.edu/doc
24 * git push (scripts-git, or gitosis on an XVM)
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
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 --recursive ssh://sipb-www@scripts.mit.edu/mit/sipb-www/git/sipb-www
50     $ cd sipb-www
51
52 You can also clone directly from the filesystem if you have AFS permission. If you want a preview of your pages to be generated locally, you can use the generate-preview.sh script in the superrepo:
53
54     $ git clone --recursive /mit/sipb-www/git/sipb-www
55     $ cd sipb-www
56     $ # make changes here
57     $ mkdir /tmp/sipb-out
58     $ ./generate-preview.sh /tmp/sipb-out
59     $ firefox /tmp/sipb-out/index.html
60
61
62 ####Detailed Locker Layout
63
64     .
65     |-- Scripts
66     |   |-- wiki: the published HTML that you are being served right now
67     |   |-- wiki-cgi: CGI scripts for the wiki
68     |   \-- writable: directory containing files writable by scripts
69     |                 dotfiles such as .bash_history are symlinked here
70     |-- git
71     |   |-- sipb-www.git: the master repo; other repos are submodules
72     |   |-- wiki.git: home of the wiki content as markdown, etc
73     |   \-- ikiwiki.git: the repo for SIPB's local variation on ikiwiki
74     |-- checkout: automatically updated checkout of sipb-www.git
75     |-- arch
76     |   \-- amd64_fedora9_scripts: binaries related to publishing ikiwiki
77     |-- bin, lib, sbin: links into arch
78     |-- man: a link into arch, ikiwiki manpages. 
79     |        add sipb-www to get them into MANPATH
80     |-- share -> arch/amd64_fedora9_scripts/share
81     |   |-- ikiwiki: where some basic things are pulled from during build
82     |   |-- locale: i18n things we aren't using
83     |   `-- man: where the manpages really live
84     |-- ikiwiki: think of it as like a mix of etc and build
85     |   |-- cgitrc : configuration for cgit
86     |   |-- ikiwiki.setup: configuration for ikiwiki
87     |   `-- src: where ikiwiki checks out wiki.git for building
88     |-- planet: Source code and templates for Planet SIPB
89     |   `-- sipb/basic: Our configuration
90     |-- src
91     |   \-- cgit: where cgit was built from (not actively changed)
92     |-- web_scripts
93     |   |-- cgit: what you look at when you click on "History"
94     |   |-- doc: the old Trac wiki
95     |   |-- radiant: old and irrelevant
96     |   |-- rtfm: contains an index.html identical to rtfm.html below
97     |   `-- sipb: the document root for sipb.mit.edu
98     |       |-- _wiki -> ../../Scripts/wiki
99     |       `-- _wiki-cgi -> ../../Scripts/wiki-cgi
100     \-- web_scripts_tmp: old directory around to keep trac up-to-date. Should
101                          vanish sooner or later
102