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 and LennyBugsAll for the bugs we took 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 [UsingScreen screen].
  17   * BarnOwl has some more documentation on [http://barnowl.mit.edu/ its wiki]
  18  * [wiki:AFSAndYou] -- an attempt at beginners guide to working with AFS for Athena and Web
  19  * UsingScreen -- Handy for [UsingZephyr Zephyr] and anything else you do in an ssh session.
  20  * [wiki:XVM] (On XVM's trac)
  21   * [https://xvm.mit.edu/trac/wiki/Remctl using `remctl`]
  22   * [https://xvm.mit.edu/trac/wiki/SerialConsole getting the serial console]
  23  * printing: QuickPrint, CupsOnMac
  24  * KerberizedServer explains keytabs and how to get one and how that lets you SSH somewhere with Kerberos.
  25  * RootInstance explains root and extra instances in Kerberos.
  26  * SummerReading -- Documents or books that various SIPB members recommend reading.
  27
  28 == Documentation Ideas ==
  29
  30 This is a list of topics that need documentation in one form or
  31 another or that are good for explaining to prospectives.
  32
  33  * PrintingAtMit
  34    * QuickPrint -- done!
  35    * `lpq`, `lprm`, `queues.mit.edu`
  36    * printing from non-Athena: CupsOnMac -- done!
  37    * `-i printadm` (maybe)
  38
  39  * [wiki:Debianization] -- packaging software for Debian and Ubuntu
  40  * UsingDebathena -- You've installed Debathena -- now what?  Automounter, `blanche`, cups; using stuff in the GUI.
  41  * AthenaDotFiles -- These are weird and nonstandard compared to traditional UNIX and should be documented, including things like `.environment`
  42    * There's some documentation at [http://web.mit.edu/olh/Dotfiles/]
  43
  44  * ScriptsMitEdu -- lots of neat internals to explain
  45
  46   -- 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.
  47
  48  Setting up servers:
  49  * 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)
  50
  51  * Add your own here!
  52
  53 == Useful Links ==
  54
  55  * WikiFormatting -- Documentation on trac's Wiki formatting language
  56  * 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.
  57  * SIPB services and projects list: http://stuff.mit.edu/sipb/project-list.html
  58
  59 === License ===
  60
  61 Unless specified otherwise, all content on this wiki is released under a dual license of
  62
  63  * the Creative Commons Attribution-Share Alike license, and
  64  * the GNU Free Documentation License, with no Invariant Sections, no
  65    Front-Cover Texts, and no Back-Cover-Texts.
  66
  67 This follows the [http://stuff.mit.edu/afs/sipb/admin/text/policy/documentation_licensing.txt SIPB Documentation Licensing Recommendation].