Structure Overview - Revision history

Nic-systems at 19:24, 4 August 2006

2006-08-04T19:24:02Z

Nic-systems at 19:22, 4 August 2006

2006-08-04T19:22:37Z

@@ Line 21: / Line 21: @@
 <pre> * [[Class:Hostname]]</pre>
-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:
+Each host's page should have information about the hardware, software, and an example of common command output on a functioning system.<br>
 [[Template:host]]
@@ Line 37: / Line 38: @@
 '''Software installed and running on one or more hosts to provide a network service'''
 === Compilers ===
 '''Specialized vendor-distributed compilers'''
 === Software ===

Nic-systems at 19:00, 4 August 2006

2006-08-04T19:00:11Z

← Older revision		Revision as of 19:00, 4 August 2006
Line 19:		Line 19:

	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: <br>		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: <br>
	* [[Class:Hostname]]		<pre> * [[Class:Hostname]]</pre>

	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:		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:

Nic-systems at 18:59, 4 August 2006

2006-08-04T18:59:07Z

← Older revision		Revision as of 18:59, 4 August 2006
Line 4:		Line 4:
	Proper namespace selection will ensure that the document is correctly indexed for search and reference purposes.		Proper namespace selection will ensure that the document is correctly indexed for search and reference purposes.

	Documents should be created in the form: '''<nowiki>[[CategoryName:DocumentTitle]]</nowiki><br>		Documents should be created in the form: '''<nowiki>[[CategoryName:DocumentTitle]]</nowiki>'''<br>
	For example, a guide to installing Octave is at: ~~'''<nowiki>~~[[Software:Octave]]~~</nowiki>~~<br>		For example, a guide to installing Octave is at: [[Software:Octave]]<br>

	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: '''<nowiki>[[CategoryName:DocumentTitle/Host]]</nowiki><br>		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: '''<nowiki>[[CategoryName:DocumentTitle/Host]]</nowiki><br>
	For example, ~~'''<nowiki>~~[[Software:Octave/Neuronic]]~~</nowiki>~~		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.<br>		Documents should also always contain a Category tag. This tag will make sure that they are automatically linked to from their Category page.<br>
	For example, any document in the Software section should contain the following wikitext: '''<nowiki>[[Category:Software]]</nowiki>		For example, any document in the Software section should contain the following wikitext: '''<nowiki>[[Category:Software]]</nowiki>'''

	== Section Specific Documentation ==		== Section Specific Documentation ==

Nic-systems at 18:58, 4 August 2006

2006-08-04T18:58:27Z

← Older revision		Revision as of 18:58, 4 August 2006
Line 5:		Line 5:

	Documents should be created in the form: '''<nowiki>[[CategoryName:DocumentTitle]]</nowiki><br>		Documents should be created in the form: '''<nowiki>[[CategoryName:DocumentTitle]]</nowiki><br>
	For example, a guide to installing ~~MPICH2~~ is at: '''<nowiki>[[Software:Octave]]</nowiki><br>		For example, a guide to installing Octave is at: '''<nowiki>[[Software:Octave]]</nowiki><br>

	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: '''<nowiki>[[CategoryName:DocumentTitle/Host]]</nowiki><br>		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: '''<nowiki>[[CategoryName:DocumentTitle/Host]]</nowiki><br>

Nic-systems at 18:57, 4 August 2006

2006-08-04T18:57:52Z

← Older revision		Revision as of 18:57, 4 August 2006
Line 4:		Line 4:
	Proper namespace selection will ensure that the document is correctly indexed for search and reference purposes.		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]]<br>		Documents should be created in the form: '''<nowiki>[[CategoryName:DocumentTitle]]</nowiki><br>
	For example, a guide to installing MPICH2 is at: [[Software:Octave]]<br>		For example, a guide to installing MPICH2 is at: '''<nowiki>[[Software:Octave]]</nowiki><br>

	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]]<br>		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: '''<nowiki>[[CategoryName:DocumentTitle/Host]]</nowiki><br>
	For example, [[Software:Octave/Neuronic]]		For example, '''<nowiki>[[Software:Octave/Neuronic]]</nowiki>

	Documents should also always contain a Category tag. This tag will make sure that they are automatically linked to from their Category page.<br>		Documents should also always contain a Category tag. This tag will make sure that they are automatically linked to from their Category page.<br>

Nic-systems at 18:57, 4 August 2006

2006-08-04T18:57:14Z

@@ Line 1: / Line 1: @@
 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.
-== Servers ==
+== Namespace selection ==
 '''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: <br>
-  * [[<class>:<hostname>]]</nowiki>
+  * [[Class:Hostname]]
-# Proceedures: Guides to common procedures such as creating a new user account or configuring LDAP
+=== Software ===

Nic-systems at 18:23, 4 August 2006

2006-08-04T18:23:24Z

← Older revision		Revision as of 18:23, 4 August 2006
Line 4:		Line 4:
	'''Host-specific hardware and software documentation'''		'''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: <br>		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: <br>
	~~<nowiki>~~* [[<class>:<hostname>]]</nowiki>.		* [[<class>:<hostname>]]</nowiki>

Nic-systems at 18:23, 4 August 2006

2006-08-04T18:23:01Z

New page

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.

== 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: <br>
<nowiki>* [[<class>:<hostname>]]</nowiki>.

# Proceedures: Guides to common procedures such as creating a new user account or configuring LDAP
# Info: Miscellaneous useful info, such as user and hardware lists
# Services: Software installed and running on one or more hosts to provide a network service
# Compilers: Specialized vendor-distributed compilers
# Software:

← Older revision		Revision as of 19:24, 4 August 2006
Line 39:		Line 39:

	Documentation on the main Service page should include:		Documentation on the main Service page should include:
	# What service the software provides		* What service the software provides
	# Where to find authoritative documentation on the software		* Where to find authoritative documentation on the software
	# Generic installation or operating instructions		* Generic installation or operating instructions
	# Any other information not specific to a specific host		* Any other information not specific to a specific host
	# A list of hosts the service is installed and running on		* A list of hosts the service is installed and running on
	# What ports or sockets does the service listen on?		* What ports or sockets does the service listen on?
	# What firewall rules are necessary to permit the service to be accessed?		* What firewall rules are necessary to permit the service to be accessed?
	# Where does the service log to?		* Where does the service log to?
	# Where are the configuration files stored?		* Where are the configuration files stored?
	# What processes should be running while the service is running?		* What processes should be running while the service is running?
	# How is the service started or stopped?		* How is the service started or stopped?

	The list of hosts from the final item above should contain links to host-specific documentation pages as described in the namespace section above. Those pages should discuss:		The list of hosts from the final item above should contain links to host-specific documentation pages as described in the namespace section above. Those pages should discuss:
	# How the service was installed		* How the service was installed
	** Package manager? Which one?		** Package manager? Which one?
	** Built from source? If so, what build options were used? Where was it installed to?		** Built from source? If so, what build options were used? Where was it installed to?
	# Any notes about running the service unique to this host		* Any notes about running the service unique to this host

	If any of the above information is provided on the generic service page, and it is accurate on this host, it may be ommited.		If any of the above information is provided on the generic service page, and it is accurate on this host, it may be ommited.
Line 62:		Line 62:
	'''Specialized vendor-distributed compilers'''		'''Specialized vendor-distributed compilers'''
	Documentation on the main Compiler page should include:		Documentation on the main Compiler page should include:
	# What purpose the compiler serves		* What purpose the compiler serves
	# Where to find authoritative documentation on the software		* Where to find authoritative documentation on the software
	# Any licensing or registration information		* Any licensing or registration information
	# A list of hosts the compiler is installed on		* A list of hosts the compiler is installed on

	The list of hosts from the final item above should contain links to host-specific documentation pages as described in the namespace section above. Those pages should discuss:		The list of hosts from the final item above should contain links to host-specific documentation pages as described in the namespace section above. Those pages should discuss:
	# How the compiler was installed		* How the compiler was installed
	# Any notes about using the compiler unique to this host		* Any notes about using the compiler unique to this host
	# Instructions for compiling and linking with this compiler		* Instructions for compiling and linking with this compiler
	# Are there configuration files? Where are they stored?		* Are there configuration files? Where are they stored?

	=== Software ===		=== Software ===
Line 77:		Line 77:

	Documentation on the main Software page should include:		Documentation on the main Software page should include:
	# What purpose the software serves		* What purpose the software serves
	# Where to find authoritative documentation on the software		* Where to find authoritative documentation on the software
	# Generic installation or operating instructions		* Generic installation or operating instructions
	# Instructions for compiling and linking against any libraries provided by this package		* Instructions for compiling and linking against any libraries provided by this package
	# Are there configuration files? Where are they stored?		* Are there configuration files? Where are they stored?
	# Any other information not specific to a specific host		* Any other information not specific to a specific host
	# A list of hosts the software is installed on		* A list of hosts the software is installed on

	The list of hosts from the final item above should contain links to host-specific documentation pages as described in the namespace section above. Those pages should discuss:		The list of hosts from the final item above should contain links to host-specific documentation pages as described in the namespace section above. Those pages should discuss:
	# How the service was installed		* How the service was installed
	** Package manager? Which one?		** Package manager? Which one?
	** Built from source? If so, what build options were used? Where was it installed to?		** Built from source? If so, what build options were used? Where was it installed to?
	# Any notes about using the software unique to this host		* Any notes about using the software unique to this host


	If any of the above information is provided on the generic service page, and it is accurate on this host, it may be ommited.		If any of the above information is provided on the generic service page, and it is accurate on this host, it may be ommited.