UbuntuServerDocumentation
|
Size: 248
Comment:
|
Size: 1922
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| Ideas on how to nicely document Ubuntu server installations. | ||<tablestyle="float:right; font-size: 0.9em; width:40%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;">'''Contents'''[[BR]][[TableOfContents]]|| |
| Line 3: | Line 3: |
| * Micro-manuals | == Introduction == |
| Line 5: | Line 5: |
| Consise, step by step manuals for getting a particular service up and running. Include details of the Ubuntu version and the version of the software that was used. | It struck me that one of the really nice things that would be good to have would be a set of concise manuals for how to set up a particular application (or set of applications) in a best practice manner. * Micro-manuals These would be concise, step by step instructions for getting a particular service up and running and include details like the Ubuntu version and the version of the software that was used, and additional references. The aim of the manuals would be to capture a significant amount of details to allow a suitable competent system administrator to know exactly how a system had been configured, should the service need to be upgraded or changed. After following the instructions, the end user should have a system which as some service or feature now set up in a completely known state. In addition, it would inform package maintainers, exectly how their software is being installed and used, and allow them to upgrade their software or packaging to minimise the amount of additional configuration required (eg. sensible defaults and minimum required configuration parameters.) In this way, the "Micro-manual" for a particular task should evolve over time to be a very minimal document. == Contents == The following is a proposed 'standard' outline: * Introduction * Statement of purpose (what does this manual describe) * Required packages and versions * Instructions * Appendices * References == Examples == * postfix with pam/ldap * Configuring mediawiki for an intranet site * Includes instructions for configuring local logo. * Setting up openVPN * Network print server * SMB File server See: ServerGuide for more possibilities. |
ContentsBRTableOfContents |
Introduction
It struck me that one of the really nice things that would be good to have would be a set of concise manuals for how to set up a particular application (or set of applications) in a best practice manner.
- Micro-manuals
These would be concise, step by step instructions for getting a particular service up and running and include details like the Ubuntu version and the version of the software that was used, and additional references.
The aim of the manuals would be to capture a significant amount of details to allow a suitable competent system administrator to know exactly how a system had been configured, should the service need to be upgraded or changed.
After following the instructions, the end user should have a system which as some service or feature now set up in a completely known state.
In addition, it would inform package maintainers, exectly how their software is being installed and used, and allow them to upgrade their software or packaging to minimise the amount of additional configuration required (eg. sensible defaults and minimum required configuration parameters.)
In this way, the "Micro-manual" for a particular task should evolve over time to be a very minimal document.
Contents
The following is a proposed 'standard' outline:
- Introduction
- Statement of purpose (what does this manual describe)
- Required packages and versions
- Instructions
- Appendices
- References
Examples
- postfix with pam/ldap
- Configuring mediawiki for an intranet site
- Includes instructions for configuring local logo.
- Setting up openVPN
- Network print server
- SMB File server
See: ServerGuide for more possibilities.
PaulSchulz/UbuntuServerDocumentation (last edited 2008-08-06 17:01:42 by localhost)