link to zulip src
[wiki.git] / doc.mdwn
index 3e55a7c576d7e5de9d614f1bcd49b9d36b7bb866..57a9b11b483d69628281cfc59521671917ba3959 100644 (file)
--- a/doc.mdwn
+++ b/doc.mdwn
@@ -2,37 +2,80 @@
 
 SIPB offers documentation for users at MIT and elsewhere.
 
+Writing and editing this documentation is an [[ongoing project|doc/project]].  Edits and other contributions welcome.
 
 ## Recent Documentation
 
+### SIPB
+
+* [[Using sipbmp3|doc/using-sipbmp3]] <br />
+A guide to queue music to sipbmp3, the gutenbach system SIPB uses to play music in the office.
+
+* [[SIPB Hands-on Assignments|doc/hands-on]] <br />
+Modeled on the [6.033 hands-on assignments], these guides will walk you through concepts and technologies that are core to many SIPB projects. We appreciate contributions!
+
+* [[Summer Reading|doc/summer-reading]] <br />
+Documents and books that various SIPB members recommend reading.
+
+* [[Moira|doc/moira]] <br />
+Some tips for using Moira
+
+* [[Pergamon|doc/pergamon]] <br />
+Setting up a mailing list archive using Pergamon, SIPB's self-service discuss server (see below for documentation on discuss)
+
+### Zephyr
+
 * [[Using Zephyr|doc/zephyr]] <br />
-A guide on using Zephyr today with BarnOwl (and GNU Screen). Aimed at newcomers to Zephyr, and a pretty good reference.  See also [the Barnowl wiki](http://barnowl.mit.edu/).
+A guide on using Zephyr today with BarnOwl (and GNU Screen). Aimed at newcomers to Zephyr, and a pretty good reference.  See also [the BarnOwl wiki](http://barnowl.mit.edu/).
 
-* [[AFS and You|doc/afs-and-you]] <br />
-A useful guide to AFS (originally the Andrew File System), the system that stores your Athena files. Targeted at mid-to-advanced users, this is a more up-to-date version than the Inessential Guide to AFS above.
+* [[Using `zcrypt`|doc/zcrypt]] <br />
+A guide to using `zcrypt`ed (encrypted) zephyr classes. Zephyr at MIT (mostly) doesn't support limiting who can sub to a zephyr class, so if you want to have reasonably private conversations, encrypting them is a good idea.
 
-* [[doc/screen]] <br />
+* [[Using SZS (the SMS to Zephyr Relay)|doc/szs]] <br />
+Send and receive text messages through Zephyr.
+
+* [[Using Screen|doc/screen]] <br />
 Handy for [[doc/Zephyr]] and anything else you do in an ssh session.
 
+
+### Kerberos and AFS
+
 * [[Kerberized Server|doc/kerberized-server]] <br />
 Explains keytabs and how to get one and how that lets you SSH somewhere with Kerberos.
 
 * [[Root Instance|doc/root-instance]] <br />
 Explains root and extra instances in Kerberos.
 
-* [[Summer Reading|doc/summer-reading]] <br />
-Documents and books that various SIPB members recommend reading.
+* [[AFS and You|doc/afs-and-you]] <br />
+A useful guide to AFS (originally the Andrew File System), the system that stores your Athena files. Targeted at mid-to-advanced users, this is a more up-to-date version than the Inessential Guide to AFS below.
+
+### Client Certificates
+
+* [[Configuring Client-Side Certificate Authentication on Apache|doc/apache-client-certs]] <br />
+How to configure your own server to accept client-side certificates just like [scripts.mit.edu](https://scripts.mit.edu/)
+
+### Miscellaneous
+
+* [scripts.mit.edu](https://scripts.mit.edu/): [user documentation](https://scripts.mit.edu/faq), [internals wiki](https://scripts.mit.edu/wiki/)
+
+* XVM: [Using `remctl`](https://xvm.mit.edu/trac/wiki/Remctl), and
+ [Getting the serial console](https://xvm.mit.edu/trac/wiki/SerialConsole)
+
+* [[Printing with CUPS on the Mac|doc/cups-on-mac]] <br />
+How to set up printing on a Mac.
+
+* [Learning Debian Packaging](http://debathena.mit.edu/packaging/)
 
+* [[Using CPAN|doc/cpan]] <br />
+CPAN is a source of many useful Perl libraries, but the tools often seem determined not to let you have them. Here's how to beat them into submission.
 
+* [[Writing safe(r) shell scripts|doc/safe-shell]]
 
 ## IAP Classes and Cluedumps
 
 SIPB teaches [an array of classes](http://sipb.mit.edu/iap) each IAP and shorter [cluedumps](http://cluedumps.mit.edu/) in the fall.
 Some of them leave notes useful as documentation.
 
-* [Java Class Notes](http://stuff.mit.edu/afs/sipb/project/iap/Archive/1999/java/outline.html) <br />
-These are the electronic slides that were used in SIPB's popular Java class.
-
 * [Understanding Git](http://web.mit.edu/cluedumps/slides/understanding-git-2008.pdf) <br />
 These slides were developed for a SIPB cluedump on the Git version control system.
 
@@ -56,7 +99,7 @@ A very helpful guide to LaTeX, a typesetting program commonly used for doing PSe
 A guide to using MATLAB on Athena.
 
 * [Inessential Zephyr](http://stuff.mit.edu/afs/sipb/project/doc/izephyr/html/izephyr.html) ([DVI](http://stuff.mit.edu/afs/sipb/project/doc/izephyr/izephyr.dvi))([PDF](http://stuff.mit.edu/afs/sipb/project/doc/izephyr/izephyr.pdf)) <br />
-A guide to using the Athena instant-messenging system, Zephyr. Less relevant now that most people use Barnowl, try [this](http://sipb-www.scripts.mit.edu/doc/wiki/UsingZephyr) instead
+A guide to using the Athena instant-messenging system, Zephyr. Less relevant now that most people use BarnOwl, try [this](http://sipb-www.scripts.mit.edu/doc/wiki/UsingZephyr) instead
 
 * [Inessential Bitmaps](http://stuff.mit.edu/afs/sipb.mit.edu/project/doc/ibitmap/ibitmap.html) ([DVI](http://stuff.mit.edu/afs/sipb/project/doc/current/ibitmap.dvi)) <br />
 A guide to drawing and displaying XBM bitmaps and other graphics.
@@ -70,6 +113,9 @@ A guide on how to restock a soda fridge. It isn't as hard as you make it look.
 * [How to Choose a Good Password](http://stuff.mit.edu/afs/sipb/project/doc/passwords/passwords.html) ([DVI](http://stuff.mit.edu/afs/sipb/project/doc/current/passwords.dvi)) <br />
 A one-page list of guidelines on how to choose secure passwords, and why this is important.
 
+* [Who Fixes What at MIT](http://stuff.mit.edu/afs/athena.mit.edu/system/info/who_fixes_what) <br />
+How and to whom to report all kinds of problems with computing infrastructure at MIT.
+
 * [Filtering Your E-Mail on Athena](http://www.mit.edu/afs/sipb/project/doc/imailfilters/imailfilters.html) <br />
 A quick guide to filtering your e-mail on Athena's common email-clients.
 
@@ -85,3 +131,14 @@ A one-page reference to reading NetNews.
 * [Using Discuss](http://stuff.mit.edu/afs/sipb/project/www/discuss/discuss.html) ([DVI](http://stuff.mit.edu/afs/sipb/project/doc/current/discuss.dvi)) <br />
 A guide to using and enjoying the Discuss bulletin board system on Athena.
 
+* [[So you want to learn Git...|doc/&git ]] <br />
+Pointers to resources from which Git, the Version Control System many of us use.
+
+
+## Licensing
+
+While we love free and open source software, there are [too many licenses](http://www.opensource.org/proliferation) and the options can get a bit confusing. SIPB has some official recommendations for what to use and how to effect these licenses.
+
+* [[Code Licensing Recommendation|doc/code-licensing]]
+
+* [[Documentation Licensing Recommendation|doc/doc-licensing]]