MaverickServerGuide

Differences between revisions 1 and 2
⇤ ← Revision 1 as of 2010-04-26 14:28:13 →
Size: 2567
Editor: cOn244
Comment: Creation
← Revision 2 as of 2010-04-26 14:45:07 → ⇥
Size: 2311
Editor: cOn244
Comment: Filled out sections.
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
 * '''Launchpad Entry''': UbuntuSpec:foo
 * '''Created''':
 * '''Contributors''':
 * '''Packages affected''':		  * '''Launchpad Entry''': [[https://blueprints.launchpad.net/ubuntu-docs/+spec/server-maverick-serverguide-updates/|server-maverick-serverguide-updates]]
 * '''Created''': 26 April 2010
 * '''Contributors''': Ubuntu Doc Team, Ubuntu Server Team
 * '''Packages affected''': ubuntu-serverguide
Line 10: Line 10:
This should provide an overview of the issue/functionality/change proposed here. Focus here on what will actually be DONE, summarising that so that other people don't have to read the whole spec. See also CategorySpec for examples. Gather and confirm ideas on additions and updates for the Server Guide during the Ubuntu 10.10 release cycle.
Line 14: Line 14:
This section should include a paragraph describing the end-user impact of this change. It is meant to be included in the release notes of the first release in which it is implemented. (Not all of these will actually be included in the release notes, at the release manager's discretion; but writing them is a useful exercise.) TBD
Line 16: Line 16:
It is mandatory.
Line 20: Line 19:
This should cover the _why_: why is this change being proposed, what justifies it, where we see this justified. A significant amount of problems with any computer system can be solved with good documentation. To that end having relevant and up to date documentation for the Ubuntu Server Edition is a worthwhile venture.
Line 26: Line 26:
It is valuable to ship Ubuntu Server Edition with updated documentation on how to install and configure some services on Ubuntu Server.
Line 27: Line 29:

You can have subsections that better describe specific parts of the issue.
Line 32: Line 32:
This section should describe a plan of action (the "how") to implement the changes discussed. Could include subsections like: Confirm or add to the proposed list of ideas gathered on the ServerTeam/IdeaPool page. Then document the confirmed subjects in DocBook format. Also, updating any relevant pages in the community wiki.
Line 34: Line 34:
=== UI Changes ===

Should cover changes required to the UI, or specific UI that is required to implement this

=== Code Changes ===

Code changes should include an overview of what needs to change, and in some cases even the specific details.

=== Migration ===

Include:
 * data migration, if any
 * redirects from old URLs to new ones, if any
 * how users will be pointed to the new way of doing things, if necessary.		 Also, fix any bugs in the documentation that are discovered or left over from previous releases.
Line 51: Line 38:
It's important that we are able to test new features, and demonstrate them to users. Use this section to describe a short plan that anybody can follow that demonstrates the feature is working. This can then be used during testing, and to show off after release. Please add an entry to http://testcases.qa.ubuntu.com/Coverage/NewFeatures for tracking test coverage.

This need not be added or completed until the specification is nearing beta.		 Read through the Server Guide, and report bugs on any issues with the guide. Issues will include grammar errors, spelling errors, command errors, application/package names, path names, etc.
Line 57: Line 42:
This should highlight any issues that should be addressed in further specifications, and not problems with the specification itself; since any specification with problems cannot be approved.
Line 61: Line 44:
Use this section to take notes during the BoF; if you keep it in the approved spec, use it for summarising what was discussed and note any options that were rejected.  * It's been proposed to discuss the best method of delivering the Server Guide content.
  * Is the current DocBook format the best?
  * Should the Guide be incorporated into the Help or Community Wikis?


 * Clustering
  * Better document the Ubuntu cluster stack.
 * Credential caching for LDAP and Kerberos client authentication.
 * Power management
  * wakeonlan
  * pmsuspend
  * pmhibernate
 * Dynamic DNS updates via DHCP.
 * Bug Fixes
 * Section Updates
  * Package names, version numbers, etc.
 * Mail Section
  * Better document the dovecot-postfix package.
  * Merge Dovecot section with Postfix.
 * Upgrading from an EOL release.
 * Instructions for virtio disks.
  * http://ubuntuforums.org/showthread.php?t=859982

Summary

Gather and confirm ideas on additions and updates for the Server Guide during the Ubuntu 10.10 release cycle.

Release Note

TBD

Rationale

A significant amount of problems with any computer system can be solved with good documentation. To that end having relevant and up to date documentation for the Ubuntu Server Edition is a worthwhile venture.

User stories

Assumptions

It is valuable to ship Ubuntu Server Edition with updated documentation on how to install and configure some services on Ubuntu Server.

Design

Implementation

Confirm or add to the proposed list of ideas gathered on the ServerTeam/IdeaPool page. Then document the confirmed subjects in DocBook format. Also, updating any relevant pages in the community wiki.

Also, fix any bugs in the documentation that are discovered or left over from previous releases.

Test/Demo Plan

Read through the Server Guide, and report bugs on any issues with the guide. Issues will include grammar errors, spelling errors, command errors, application/package names, path names, etc.

Unresolved issues

BoF agenda and discussion

  • It's been proposed to discuss the best method of delivering the Server Guide content.

    • Is the current DocBook format the best?

    • Should the Guide be incorporated into the Help or Community Wikis?
  • Clustering
    • Better document the Ubuntu cluster stack.
  • Credential caching for LDAP and Kerberos client authentication.
  • Power management
    • wakeonlan
    • pmsuspend
    • pmhibernate
  • Dynamic DNS updates via DHCP.
  • Bug Fixes
  • Section Updates
    • Package names, version numbers, etc.
  • Mail Section
    • Better document the dovecot-postfix package.
    • Merge Dovecot section with Postfix.
  • Upgrading from an EOL release.
  • Instructions for virtio disks.

CategorySpec

MaverickServerGuide (last edited 2010-07-20 20:21:08 by nc-67-237-62-65)