X-Git-Url: https://sipb.mit.edu/gitweb.cgi/wiki.git/blobdiff_plain/0d73089583e2f601b51ce7be2c8782235f30246a..5366eff6086c146039dccc16680ea69ad2da733b:/doc/WikiStart diff --git a/doc/WikiStart b/doc/WikiStart index f9073f8..8dec40d 100644 --- a/doc/WikiStart +++ b/doc/WikiStart @@ -1,10 +1,67 @@ = Welcome to the SIPB Documentation Project = -The SIPB Documentation Project is a project to document in written form the collective knowledge that SIPB members take for granted or use in maintaining services and projects that are not previously written down anywhere. +The SIPB Documentation Project is a project to document in written +form the collective knowledge that SIPB members take for granted or +use in maintaining services and projects that are not otherwise +written down anywhere. -To kick off the project, we will be holding a SIPB Documentathon in the SIPB office on Sunday, September 14, starting at 1pm. Anyone who either has or wants knowledge about computing at MIT or SIPB is welcome! +See '''ProjectIdeas''' for stuff to try doing to further the goals of the SIPB. + +See LennyBugs and LennyBugsAll for the bugs we took on in the Lenny +RC-bug-squashing hackathon of December 13, 2008. + +== Documentation Topics == + + * UsingZephyr -- An attempt at a complete beginner's guide to getting + on Zephyr with BarnOwl and [UsingScreen screen]. + * BarnOwl has some more documentation on [http://barnowl.mit.edu/ its wiki] + * UsingScreen -- Handy for [UsingZephyr Zephyr] and anything else you do in an ssh session. + * [wiki:XVM] (On XVM's trac) + * [https://xvm.mit.edu/trac/wiki/Remctl using `remctl`] + * [https://xvm.mit.edu/trac/wiki/SerialConsole getting the serial console] + * printing: QuickPrint, CupsOnMac + * KerberizedServer explains keytabs and how to get one and how that lets you SSH somewhere with Kerberos. + * RootInstance explains root and extra instances in Kerberos. + * SummerReading -- Documents or books that various SIPB members recommend reading. + +== Documentation Ideas == + +This is a list of topics that need documentation in one form or +another or that are good for explaining to prospectives. + + * PrintingAtMit + * QuickPrint -- done! + * `lpq`, `lprm`, `queues.mit.edu` + * printing from non-Athena: CupsOnMac -- done! + * `-i printadm` (maybe) + + * [wiki:Debianization] -- packaging software for Debian and Ubuntu + + * UsingDebathena -- You've installed Debathena -- now what? Automounter, `blanche`, cups; using stuff in the GUI. + * AthenaDotFiles -- These are weird and nonstandard compared to traditional UNIX and should be documented, including things like `.environment` + * There's some documentation at [http://web.mit.edu/olh/Dotfiles/] + + * ScriptsMitEdu -- lots of neat internals to explain + + * [wiki:AFSAndYou] -- 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. + + Setting up servers: + * 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) + + * Add your own here! == Useful Links == * WikiFormatting -- Documentation on trac's Wiki formatting language - * DocumentationIdeas -- Projects or services in need of documentation by someone + * 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. + * SIPB services and projects list: http://stuff.mit.edu/sipb/project-list.html + +=== License === + +Unless specified otherwise, all content on this wiki is released under a dual license of + + * the Creative Commons Attribution-Share Alike license, and + * the GNU Free Documentation License, with no Invariant Sections, no + Front-Cover Texts, and no Back-Cover-Texts. + +This follows the [http://stuff.mit.edu/afs/sipb/admin/text/policy/documentation_licensing.txt SIPB Documentation Licensing Recommendation].