273
edits
Release Management/Release Notes: Difference between revisions
Release Management/Release Notes (view source)
Revision as of 14:43, 6 December 2023
, 6 December 2023Included steps for when adding a release note in Nucleus with a rollout
No edit summary |
(Included steps for when adding a release note in Nucleus with a rollout) |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 71: | Line 71: | ||
*** Add the bug number in the Bug field. | *** Add the bug number in the Bug field. | ||
*** If the note is Nightly only use a html tag to indicate it’s nightly only. | *** If the note is Nightly only use a html tag to indicate it’s nightly only. | ||
** | ** If the release note is not Nightly only comment on the bug to inform it was added to nightly. | ||
*** "Thanks, added to Nightly release notes. Keeping the relnote? flag open to keep it on the radar for inclusion in our final release notes." | *** "Thanks, added to the Nightly release notes. Keeping the relnote? flag open to keep it on the radar for inclusion in our final release notes." | ||
** If the release note is Nightly only: | |||
*** Set the relnote flag to ''nightly+'' and add a comment: | |||
**** "Thanks, added to the Nightly release notes" | |||
== Beta - Refining notes during the Beta cycle == | == Beta - Refining notes during the Beta cycle == | ||
| Line 122: | Line 125: | ||
===Day after the release notes deadline=== | ===Day after the release notes deadline=== | ||
* Add a release note for new contributors | |||
** See [https://github.com/mozilla/Relman/wiki/Running-new-contributor-script Running new contributor script] for instructions on the script. | |||
** Use the Community category when adding the release note. | |||
* Review the draft release notes document. | * Review the draft release notes document. | ||
* Inform the Release Management team the document is ready for peer review. | |||
** Another member of the team will review the release notes for clarity and/or to suggest improvements. | |||
* Create a new release in Nucleus for Desktop, Android, and iOS. | * Create a new release in Nucleus for Desktop, Android, and iOS. | ||
* Add release notes from the draft release notes document. | * Add release notes from the draft release notes document. | ||
| Line 128: | Line 136: | ||
** Order the release notes via the ''sort num'', the order will be from highest number to lowest. Otherwise, the default order is based when the release notes were added to the release. | ** Order the release notes via the ''sort num'', the order will be from highest number to lowest. Otherwise, the default order is based when the release notes were added to the release. | ||
** Group items that belong to a category in the same order. For example, items with WebRTC can be grouped together. | ** Group items that belong to a category in the same order. For example, items with WebRTC can be grouped together. | ||
** If the release note covers a feature that is part of a rollout and not enabled by default then enable '''Progressive rollout'''. | |||
*** If rollout is only targetted at specific countries then select ''Relevant countries'' from the list of '''Available relevant countries''' | |||
* Set the relnote tracking flag to XXX+ | * Set the relnote tracking flag to XXX+ | ||
* Share a link to the staged Release Notes on [https://mozilla.slack.com/archives/C9L102H6X #release-notes] internal Slack channel. | * Share a link to the staged Release Notes on [https://mozilla.slack.com/archives/C9L102H6X #release-notes] internal Slack channel. | ||
| Line 147: | Line 157: | ||
* Create a release in Nucleus. | * Create a release in Nucleus. | ||
** Add the release notes. Include the bug number indicated in a link between parentheses at the end. | ** Add the release notes. Include the bug number indicated in a link between parentheses at the end. | ||
* | * Add a link to the reference release notes for the major version e.g.: Reference link to [https://www.mozilla.org/firefox/102.0/releasenotes/ 102.0 release notes]. | ||
* | * Share a link to the staged Release Notes on [https://mozilla.slack.com/archives/C9L102H6X #release-notes] internal Slack channel. | ||
== Known Issues Release Notes == | == Known Issues Release Notes == | ||
| Line 166: | Line 176: | ||
** Avoid using colloquialisms or idioms. These can be confusing for readers depending on their region or their native language. | ** Avoid using colloquialisms or idioms. These can be confusing for readers depending on their region or their native language. | ||
** Avoid using abbreviations. For example, "pref" should be "preference". | ** Avoid using abbreviations. For example, "pref" should be "preference". | ||
* Avoid mentioning about:config prefs | |||
* For new or changed features focus on how it affects the user’s experience of Firefox, not what the software itself is doing. | * For new or changed features focus on how it affects the user’s experience of Firefox, not what the software itself is doing. | ||
** Example: "To prevent session loss for inexperienced macOS users, Firefox now requests the user’s permission to install itself if it is being run from a mounted .dmg file. This request is only made the first time Firefox is run on a user’s computer." | ** Example: "To prevent session loss for inexperienced macOS users, Firefox now requests the user’s permission to install itself if it is being run from a mounted .dmg file. This request is only made the first time Firefox is run on a user’s computer." | ||
| Line 193: | Line 204: | ||
In Nucleus you should associate each note with a category. The notes will be grouped by category in the templated page on mozilla.org. | In Nucleus you should associate each note with a category. The notes will be grouped by category in the templated page on mozilla.org. | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Tag (Category) !! Use Case | |||
|- | |- | ||
| New || New features | | New || New features | ||
| Line 205: | Line 217: | ||
|- | |- | ||
| HTML5 || Issues related to Web platform | | HTML5 || Issues related to Web platform | ||
|- | |- | ||
| Enterprise || Used to link to the enterprise release notes | | Enterprise || Used to link to the enterprise release notes | ||
| Line 214: | Line 224: | ||
|} | |} | ||
The ''Is known issue'' checkbox is used for issues that are not resolved in this release. They are categorized under ''Unresolved'' in the templated page on mozilla.org. | |||
=== Adding Images === | |||
Release notes can include images as follows: | |||
* Compress the image png with [https://tinypng.com/ tinypng.com] | |||
* Use an appropriate filename that includes the release version. | |||
* Commit the image to https://github.com/mozilla/release-notes-media/ | |||
** Please see the repo README for additional details. | |||
* Use the image URL in the Nucleus release note with appropriate alt text. | |||
* Example: | |||
** Image Source: 'https://github.com/mozilla/release-notes-media/blob/main/media/115_devtools.png' | |||
** Image URL: 'https://www.mozilla.org/media/img/firefox/releasenotes/note-images/115_devtools.png' | |||
** Release Note: https://nucleus.mozilla.org/admin/rna/note/789608/change/ | |||
* The <code><img></code> tag can also be used, which also allows the use of <code>height</code> and <code>width</code> attributes if resizing is necessary. | |||
** NOTE: The <code>height</code> and <code>width</code> attributes <b>must</b> be specified before the <code>alt</code> attribute or the image will not appear in the preview pane. It will still appear as expected in Bedrock, however. | |||
[[category:Release_Management|Release Notes]] | [[category:Release_Management|Release Notes]] | ||
[[category:Release_Management:Processes|Release Notes]] | [[category:Release_Management:Processes|Release Notes]] | ||