58c20dfc3c8cdc0ecc8996fe59c67a1805e18f56
[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.
7
8 See [[SIPB Documentation|/doc]] for documentation produced so far.
9 Existing documentation can always be improved.
10
11 <!-- See LennyBugs and LennyBugsAll for the bugs we took on in the Lenny
12 RC-bug-squashing hackathon of December 13, 2008. -->
13
14
15 ## Documentation Ideas
16
17 This is a partial list of further topics that need documentation.
18 Additions welcome.
19
20  * "Printing at MIT"
21    * `lpq`, `lprm`, `queues.mit.edu`
22    * `-i printadm` (maybe)
23
24  * "Using Debathena" -- You've installed Debathena -- now what?  Automounter, `blanche`, cups; using stuff in the GUI.
25  * "Athena Dotfiles" -- These are weird and nonstandard compared to traditional UNIX and should be documented, including things like `.environment`
26    * There's some documentation at [http://web.mit.edu/olh/Dotfiles/]
27
28  * scripts.mit.edu -- lots of neat internals to explain
29
30  * AFS: There should be a central documentation point to using your
31    AFS space, granting access through AFS and through `web`, accessing
32    files from various platforms, and so on.  Don't duplicate iAFS;
33    perhaps latex2html and update it.
34
35  Setting up servers:
36
37  * "Client Certs" should explain, if for some perverse reason you don't
38    want to use scripts.mit.edu :-), how to set up client cert
39    authentication on your own machine (grab the CA out of the
40    apache-ssl locker, submit a CSR to mitcert@, set up scripts' magic
41    Apache modules to make your life easier)
42
43  * Add your own here!
44
45
46 ## Useful Links
47
48  * [[ikiwiki/Formatting]] -- Documentation on this wiki's formatting language