(no commit message)
[wiki.git] / doc / WikiStart
1 = Welcome to the 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 ProjectIdeas for stuff to try doing to further the goals of the SIPB.
9
10 See '''LennyBugs''' for bugs to take on in the Lenny
11 '''RC-bug-squashing hackathon''' of '''December 13, 2008'''.
12
13 == Documentation Topics ==
14
15  * UsingZephyr -- An attempt at a complete beginner's guide to getting
16    on Zephyr with BarnOwl and screen.
17   * BarnOwl has some more documentation on [http://barnowl.mit.edu/ its wiki]
18  * [wiki:XVM] (On XVM's trac)
19   * [https://xvm.mit.edu/trac/wiki/Remctl using `remctl`]
20   * [https://xvm.mit.edu/trac/wiki/SerialConsole getting the serial console]
21  * SummerReading -- Documents or books that various SIPB members recommend reading.
22
23 == Documentation Ideas ==
24
25 This is a list of topics that need documentation in one form or
26 another or that are good for explaining to prospectives.
27
28  * PrintingAtMit
29    * QuickPrint
30    * `lpq`, `lprm`, `queues.mit.edu`
31    * printing from non-Athena: CupsOnMac
32    * `-i printadm` (maybe)
33
34  * UsingDebathena -- You've installed Debathena -- now what?  Automounter, `blanche`, cups; using stuff in the GUI.
35  * AthenaDotFiles -- These are weird and nonstandard compared to traditional UNIX and should be documented, including things like `.environment`
36    * There's some documentation at [http://web.mit.edu/olh/Dotfiles/]
37
38  * ScriptsMitEdu -- lots of neat internals to explain
39
40  * [wiki:AFSAndYou] -- There should be a central documentation point to using your AFS space, granting access through AFS and through `web`, accessing files from various platforms, and so on.  Don't duplicate iAFS; perhaps latex2html and update it.
41
42  Setting up servers:
43  * KerberizedServer explains keytabs and how to get one and how that lets you SSH somewhere with Kerberos.
44  * ClientCerts should explain, if for some perverse reason you don't want to use scripts.mit.edu :-), how to set up client cert authentication on your own machine (grab the CA out of the apache-ssl locker, submit a CSR to mitcert@, set up scripts' magic Apache modules to make your life easier)
45
46  * Add your own here!
47
48 == Useful Links ==
49
50  * WikiFormatting -- Documentation on trac's Wiki formatting language
51  * SIPB's [http://stuff.mit.edu/sipb/docs.html Inessential Guides]. A previous generation of SIPB documentation. Much of it is dated, but still contains useful knowledge that should be updated or moved here.
52  * SIPB services and projects list: http://stuff.mit.edu/sipb/project-list.html
53
54 === License ===
55
56 Unless specified otherwise, all documentation on this wiki will be available under a dual license of
57
58  * the Creative Commons Attribution-Share Alike license, and
59  * the GNU Free Documentation License, with no Invariant Sections, no
60    Front-Cover Texts, and no Back-Cover-Texts.
61
62 As recommended by the [http://stuff.mit.edu/afs/sipb/admin/text/policy/documentation_licensing.txt SIPB Documentation Licensing Recommendation]