Structure Overview

NIC systems information is organized into a number of categories. This document will attempt to explain the divisions, and act as a guide to adding further information.

Namespace selection

Proper namespace selection will ensure that the document is correctly indexed for search and reference purposes.

Documents should be created in the form: [[CategoryName:DocumentTitle]]
For example, a guide to installing Octave is at: Software:Octave

If the documentation is specific to a host, use the same structure, but with a slash followed by the host name or type that the information is specific to: [[CategoryName:DocumentTitle/Host]]
For example, Software:Octave/Neuronic

Documents should also always contain a Category tag. This tag will make sure that they are automatically linked to from their Category page.
For example, any document in the Software section should contain the following wikitext: [[Category:Software]]

Section Specific Documentation

Servers

Host-specific hardware and software documentation

Server documentation is divided into two host classes: Compute and Infratstructure nodes. These two types are futher divided by architecture. New hosts should be added to the end of the list in their proper section. The link should reference the host's class and short hostname (not FQDN) in the form:

* Class:Hostname

Each host's page should have information about the hardware, software, and an example of common command output on a functioning system. See the following page for a template: Template:host

Proceedures

Guides to common procedures such as creating a new user account or configuring LDAP

Any guide that does not fit into another section should go here.

Info

Miscellaneous useful info, such as user and hardware lists

Any general collection of information should go here.

Services

Software installed and running on one or more hosts to provide a network service

Compilers

Specialized vendor-distributed compilers