Warning Livedoc is no longer being updated and will be deprecated shortly. Please refer to https://documentation.tjhsst.edu.

Main Page

From Livedoc - The Documentation Repository
Revision as of 21:58, 5 November 2005 by Dan Tran (talk | contribs) (Should/should nots of LiveDoc, rearrangement.)
Jump to: navigation, search

Welcome

Welcome to the TJHSST Computer Systems Lab LiveDoc. The LiveDoc is an online repository of CSL related documentation. All aspects of the lab should be throughly documented here in order to keep a generally accurate history of the lab itself and to aid in the administration of the lab.

Start working on LiveDoc!

Please contact Andrew Deason or Dan Tran in order to get an account on LiveDoc. You must have an account in order to edit or create any pages.

What LiveDoc should be

  • LiveDoc should detail CSL specific documentation such as setups of custom services, the inner workings of proprietary equipment pertaining to CSL only usage, etc. The hope is that we have a central location where all this is recorded so that future sysadmins or helpers can understand what they're working on so they don't have to figure it out themselves.
  • LiveDoc can be thought of as the Book version 2.0. The main problem with the old Book is that it was a clumsy way to record information that changed constantly (e.g. weekly). LiveDoc hopes to fix this by making it easily editable and readable, and also efficiently structured.

What articles should contain

Articles should touch on a bit of history (e.g. the Cray was brought in what year? why? etc.) and mostly focus on the operation and other administrative details (e.g. bootup sequence, what the switches mean, how the blue lights are rigged, etc.).

Editing guidelines

One of the reasons LiveDoc was created was to have documentation

What LiveDoc shouldn't be

  • LiveDoc shouldn't be general documentation of stock services; these are readily available online. However, the article should contain a bit of general information to get the more important facts in the article through.

Important Links