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