⇤ ← Revision 1 as of 2008-02-07 16:48:08
Size: 2040
Comment:
|
Size: 2077
Comment: lock to prevent vandalism and keep authoritative
|
Deletions are marked like this. | Additions are marked like this. |
Line 1: | Line 1: |
#acl AdminGroup:read,write All:read |
Introduction
We have a simple review process for Launchpad help materials. Our two aims for the review process are to:
- minimise bottlenecks
- ensure Launchpad help materials are both accurate and easy to read.
If you produce or edit Launchpad help materials, please do take a few moments to get your work reviewed.
Minor edits in the Help wiki
- Make your changes directly in the help wiki.
- Mail the launchpad-users list with a diff of your change. Start the email's subject with "Doc RFC:".
Substantial Help wiki edits
Before editing, copy the wiki page contents into an /Edit page: e.g. if you're editing the Feeds page, copy its unedited contents into Feeds/Edit.
Save the unedited version in the /Edit page, to enable a reviewer to easily produce a diff between your draft and the original.
Write "Draft copy" at the top of the page as a = header.
- Make your edits.
Mail the launchpad-users list and cc matthew.revell@canonical.com with a link to your draft in /Edit. Start the email's subject with "Doc RFC:".
- Iteratively edit the document and republish the draft, following review comments on the mailing list.
- At least one other member of the team should declare the page ready for publication.
Remove the draft warning, publish to the main page and then delete /Edit page.
New pages
Create an /Edit page under the new page - e.g. /NewPage/Edit
Write "Draft copy" at the top of the page as a = header.
- Make your edits.
Mail the launchpad-users list and cc matthew.revell@canonical.com with a link to your draft in /Edit. Start the email's subject with "Doc RFC:".
- Iteratively edit the document and republish the draft, following review comments on the mailing list.
- At least one other member of the team should declare the page ready for publication.
Remove the draft warning, publish to the main page and then delete /Edit page.