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