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 [[Project Ideas|doc/project-ideas]] for stuff to try doing to
   9 further the goals of the SIPB.
  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 ## Documentation Topics
  15
  16  * [[doc/Zephyr]] -- An attempt at a complete beginner's guide to getting
  17    on Zephyr with BarnOwl and [[doc/screen]].
  18   * BarnOwl has some more documentation on [its wiki](http://barnowl.mit.edu/).
  19  * [[AFS and You|doc/AFS-and-you]] -- an attempt at a beginner's guide to working with AFS for Athena and Web
  20  * [[doc/screen]] -- Handy for [[doc/Zephyr]] and anything else you do in an ssh session.
  21  * XVM:
  22   * [using `remctl`](https://xvm.mit.edu/trac/wiki/Remctl)
  23   * [getting the serial console](https://xvm.mit.edu/trac/wiki/SerialConsole)
  24  * printing: [[doc/quickprint]], [[doc/cups-on-mac]]
  25  * [[Kerberized Server|doc/kerberized-server]] explains keytabs and how to get one and how that lets you SSH somewhere with Kerberos.
  26  * [[Root Instance|doc/root-instance]] explains root and extra instances in Kerberos.
  27  * [[Summer Reading|doc/summer-reading]] -- Documents or books that various SIPB members recommend reading.
  28  * [[doc/Debianization]] -- packaging software for Debian and Ubuntu
  29
  30 ## Documentation Ideas
  31
  32 This is a list of further topics that need documentation in one form
  33 or another or that are good for explaining to prospectives.
  34
  35  * "Printing at MIT"
  36    * `lpq`, `lprm`, `queues.mit.edu`
  37    * `-i printadm` (maybe)
  38
  39  * "Using Debathena" -- You've installed Debathena -- now what?  Automounter, `blanche`, cups; using stuff in the GUI.
  40  * "Athena Dotfiles" -- These are weird and nonstandard compared to traditional UNIX and should be documented, including things like `.environment`
  41    * There's some documentation at [http://web.mit.edu/olh/Dotfiles/]
  42
  43  * scripts.mit.edu -- lots of neat internals to explain
  44
  45  * AFS: There should be a central documentation point to using your
  46    AFS space, granting access through AFS and through `web`, accessing
  47    files from various platforms, and so on.  Don't duplicate iAFS;
  48    perhaps latex2html and update it.
  49
  50  Setting up servers:
  51
  52  * "Client Certs" should explain, if for some perverse reason you don't
  53    want to use scripts.mit.edu :-), how to set up client cert
  54    authentication on your own machine (grab the CA out of the
  55    apache-ssl locker, submit a CSR to mitcert@, set up scripts' magic
  56    Apache modules to make your life easier)
  57
  58  * Add your own here!
  59
  60 ## Useful Links
  61
  62  * [[ikiwiki/Formatting]] -- Documentation on this wiki's formatting language
  63  * SIPB's [Inessential Guides](http://stuff.mit.edu/sipb/docs.html). A
  64    previous generation of SIPB documentation. Much of it is dated, but some
  65    still contains useful knowledge that should be updated or moved here.
  66  * [SIPB services and projects list](http://stuff.mit.edu/sipb/project-list.html)