RFR: Section on release notes [v2]

[Jesper Wilhelmsson]

On Fri, 18 Feb 2022 02:47:39 GMT, David Holmes <dholmes at openjdk.org> wrote:

>> Jesper Wilhelmsson has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   Fixes after reviews from David and Lance
>
> src/index.md line 1549:
> 
>> 1547: #. Create a sub-task of the same JBS issue that you want a release note for (not of the CSR).
>> 1548:    * Prefix the name of the sub-task with "Release Note:".
>> 1549:    * The title of the release note sub-task should be a one sentence synopsis that is informative (and concise) enough to attract the attention of users, developers, and maintainers who might be impacted by the change.
> 
> The title should succinctly describe what has actually changed, not be the original bug title, nor describe the problem that was being solved. It should real well as a sub-section heading in a document.

Added.  Did you mean "read well" or is "real well" a term that I'm not aware of in this context?

> src/index.md line 1554:
> 
>> 1552:    * Assign the sub-task to the person who should write the release note.
>> 1553:    * Set the Fix Version of the sub-task to the same value that the main issue has.
>> 1554:    * Enter the text of the release note in the **Description** field. Some markdown formatting is available (even though it's not rendered in JBS).
> 
> Suggestion:
> 
> Enter the text of the release note in the **Description** field using markdown formatting (even though it won't be rendered in JBS).

Yes, that looks better.

-------------

PR: https://git.openjdk.java.net/guide/pull/75