Confirmed users
1,320
edits
Release Management/Documentation guidelines: Difference between revisions
Jump to navigation
Jump to search
Release Management/Documentation guidelines (view source)
Revision as of 14:38, 12 April 2018
, 12 April 2018Add process box template example + nice title
(First drafft) |
(Add process box template example + nice title) |
||
| Line 7: | Line 7: | ||
== Release_Management Namespace == | == Release_Management Namespace == | ||
Our team namespace is Release_Management, don't create a RM page outside of this namespace. | Our team namespace is Release_Management, don't create a RM page outside of this namespace. | ||
| Line 18: | Line 17: | ||
== Categories == | == Categories == | ||
We currently use two categories, one with our Namespace only which is used to inventory all of our pages and one for pages that describre a process. | We currently use two categories, one with our Namespace only which is used to inventory all of our pages and one for pages that describre a process. | ||
| Line 46: | Line 44: | ||
{{RELEASE_MANAGEMENT_UPDATE_NEEDED}} | {{RELEASE_MANAGEMENT_UPDATE_NEEDED}} | ||
{{RELEASE_MANAGEMENT_STUB}} | {{RELEASE_MANAGEMENT_STUB}} | ||
== Page titles == | |||
Please put a real title at the top of the page, otherwise the title is extracted from the URL which is not always ideal. | |||
So as to do it, use this template call at the top of the page: | |||
<nowiki> | |||
{{DISPLAYTITLE:Release Management documentation guidelines}} | |||
</nowiki> | |||
== Process pages == | == Process pages == | ||
All pages that describe a process (writing release notes, dealing with a chemspill, respinning nightlies…) should be added to the Processes category. | All pages that describe a process (writing release notes, dealing with a chemspill, respinning nightlies…) should be added to the ''Processes'' category. | ||
A process page should have a ''Process card'' on the right which gives an overview of the purpose, expected results and people involved in the process describred in the page. | |||
Example: | |||
{{Processbox | |||
| Process name = Nightly respin | |||
| Purpose = Update our users' broken nightlies | |||
| Why = A patch on mozilla-central broke Nightly badly (crash, broken UI…) | |||
| Goals = Nightly population retention | |||
| People = Relman, releng | |||
}} | |||
{{clear}} | |||
The first section of the page should be called '''Summarized Process''' and | The box above was automatically generated with the following template: | ||
<pre> | |||
<nowiki> | |||
{{Processbox | |||
| Process name = Nightly respin | |||
| Purpose = Update our users' broken nightlies | |||
| Why = A patch on mozilla-central broke Nightly badly (crash, broken UI…) | |||
| Goals = Nightly population retention | |||
| People = Relman, releng | |||
}} | |||
</nowiki> | |||
</pre> | |||
The first section of the page should be called '''Summarized Process''' and be an ordered list of tasks to do. | |||
The purpose is to give a list of steps to do for people that already did the process while still documenting the details and background information in the later sections for people that are learning the process or look for a specific information about the process.This way we maintain one document only for both new and experienced release managers. | |||
[[category:Release_Management|Documentation, guidelines]] | [[category:Release_Management|Documentation, guidelines]] | ||