(no commit message)
[wiki.git] / doc / project.mdwn
1 [[!meta title="SIPB Documentation Project"]]
2
3 The SIPB Documentation Project is a project to document in written
4 form the collective knowledge that SIPB members take for granted or
5 use in maintaining services and projects that are not otherwise
6 written down anywhere. Generally, there are two places where documentation can be found at SIPB, the first being this website, and the other being our GitHub internal wiki. To request access to the internal wiki, contact [sipb-secretary@mit.edu](mailto://sipb-secretary@mit.edu). To request modifications of the website, please contact [sipb-webmaster@mit.edu](mailto://sipb-webmaster@mit.edu).
7
8 See [[SIPB Documentation|/doc]] for documentation produced so far.
9 Existing documentation can always be improved.
10
11 Other SIPB educational activites include the [AskSIPB](https://www.mit.edu/~asksipb/) column in The Tech, an array of [IAP classes](https://sipb.mit.edu/iap/), and the weekly [Cluedumps](http://cluedumps.mit.edu/) series each fall.
12
13
14 ## Documentation Ideas
15
16 This is a partial list of further topics that need documentation.
17 Additions welcome.
18
19  * "Printing at MIT"
20    * `lpq`, `lprm`, `queues.mit.edu`
21    * `-i printadm` (maybe)
22
23  * "Using Debathena" -- You've installed Debathena -- now what?  Automounter, `blanche`, cups; using stuff in the GUI.
24  * "Athena Dotfiles" -- These are weird and nonstandard compared to traditional UNIX and should be documented, including things like `.environment`
25    * There's some documentation at [https://web.mit.edu/olh/Dotfiles/]
26
27  * scripts.mit.edu -- lots of neat internals to explain; the scripts.mit.edu bugtracker also includes some identified [documentation tasks](https://scripts.mit.edu/trac/query?status=assigned&status=new&status=reopened&keywords=~docs&group=component&col=id&col=summary&col=status&col=owner&col=type&col=priority&col=milestone&col=keywords&order=priority)
28
29  * Add your own here!
30
31 ## Useful Links
32
33  * [[ikiwiki/Formatting]] -- Documentation on this wiki's formatting language