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