383
edits
Release Management/Release Notes: Difference between revisions
no edit summary
No edit summary |
No edit summary |
||
| 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 the 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 150: | Line 153: | ||
* 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 197: | Line 200: | ||
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" | ||
|- | |- | ||
| Line 219: | Line 221: | ||
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. | 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/ | |||
[[category:Release_Management|Release Notes]] | [[category:Release_Management|Release Notes]] | ||
[[category:Release_Management:Processes|Release Notes]] | [[category:Release_Management:Processes|Release Notes]] | ||