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 Other SIPB educational activites include the [AskSIPB](http://www.mit.edu/~asksipb/) column in The Tech, an array of [IAP classes](http://sipb.mit.edu/iap/), and the weekly [Cluedumps](http://cluedumps.mit.edu/) series each fall.
  12
  13
  14 <!-- See LennyBugs and LennyBugsAll for the bugs we took on in the Lenny
  15 RC-bug-squashing hackathon of December 13, 2008. -->
  16
  17
  18 ## Documentation Ideas
  19
  20 This is a partial list of further topics that need documentation.
  21 Additions welcome.
  22
  23 * [[doc/Debianization]] (started, open for someone to finish) <br />
  24 How to package software for Debian and Ubuntu.  Popular topic in SIPB projects thanks to [Debathena](http://debathena.mit.edu/) and [XVM](http://xvm.mit.edu).
  25
  26
  27  * "Printing at MIT"
  28    * `lpq`, `lprm`, `queues.mit.edu`
  29    * `-i printadm` (maybe)
  30
  31  * "Using Debathena" -- You've installed Debathena -- now what?  Automounter, `blanche`, cups; using stuff in the GUI.
  32  * "Athena Dotfiles" -- These are weird and nonstandard compared to traditional UNIX and should be documented, including things like `.environment`
  33    * There's some documentation at [http://web.mit.edu/olh/Dotfiles/]
  34
  35  * scripts.mit.edu -- lots of neat internals to explain
  36
  37  * AFS: There should be a central documentation point to using your
  38    AFS space, granting access through AFS and through `web`, accessing
  39    files from various platforms, and so on.  Don't duplicate iAFS;
  40    perhaps latex2html and update it.
  41
  42  Setting up servers:
  43
  44  * "Client Certs" should explain, if for some perverse reason you don't
  45    want to use scripts.mit.edu :-), how to set up client cert
  46    authentication on your own machine (grab the CA out of the
  47    apache-ssl locker, submit a CSR to mitcert@, set up scripts' magic
  48    Apache modules to make your life easier)
  49
  50  * Add your own here!
  51
  52
  53 ## Useful Links
  54
  55  * [[ikiwiki/Formatting]] -- Documentation on this wiki's formatting language