[PATCH 5/5] docs: add release note for addressed/unaddressed comments

[Stephen Finucane]

On Wed, 2021-08-11 at 09:57 +1000, Daniel Axtens wrote:
> Raxel Gutierrez <raxel at google.com> writes:
> 
> > Signed-off-by: Raxel Gutierrez <raxel at google.com>
> > ---
> >  ...essed-patch-comments-bfe71689b6f35a22.yaml | 20 +++++++++++++++++++
> >  1 file changed, 20 insertions(+)
> >  create mode 100644 releasenotes/notes/comment-detail-endpoint-for-addressed-unaddressed-patch-comments-bfe71689b6f35a22.yaml
> > 
> > diff --git a/releasenotes/notes/comment-detail-endpoint-for-addressed-unaddressed-patch-comments-bfe71689b6f35a22.yaml b/releasenotes/notes/comment-detail-endpoint-for-addressed-unaddressed-patch-comments-bfe71689b6f35a22.yaml
> > new file mode 100644
> > index 0000000..1b11d01
> > --- /dev/null
> > +++ b/releasenotes/notes/comment-detail-endpoint-for-addressed-unaddressed-patch-comments-bfe71689b6f35a22.yaml
> > @@ -0,0 +1,20 @@
> > +---
> > +prelude: >
> > +    Comments on a patch now have an addressed/unaddressed state visible as a
> > +    label on each comment's header. Also, the patch comment header includes a
> > +    button to change the ``addressed`` state of each respective comment. Only
> > +    users with edit permissions can see the button and make these changes. To
> > +    make updates to the ``addressed`` field of the ``PatchComment`` model, a
> > +    new REST API endpoint ``/api/patches/<patch_id>/comments/<comment_id>/`` is
> > +    added to retrieve and update individual patch comments.
> 
> Looking at existing release notes, we only use 'prelude' for release
> notes specifically announcing new
> versions. (e.g. releasenotes/notes/prelude-3_0-5a4905b9df203595.yaml)
> 
> A couple of changes:
> 
>  - please move any content you want preserved from prelude to another
>    type of note.
> 
>  - as these are user-visible, it would be good if you could explain the
>    changes without referring to the model names inside of Patchwork.
> 

+1 on both fronts. Release notes should be user-facing and 'prelude' should only
be used by maintainers when preparing new major/minor releases.

> > +features:
> > +  - |
> > +    Patch comments now have "Addressed" and "Unaddressed" labels in the patch
> > +    detail page. Users that are project maintainers, patch delegates, patch
> > +    submitter, or comment submitter can change the ``addressed`` state of each
> > +    comment on a patch with a button next to each label.
> > +api:
> > +  - |
> > +    The API version has been updated to v1.3.
> > +  - |
> > +    New REST API endpoint at ``/api/patches/<patch_id>/comments/<comment_id>/``.

nit: Let's use full sentences and provide a bit of context about why this is
useful.

  A new REST API endpoint is available at ...
  This can be used to ...

> > -- 
> > 2.32.0.554.ge1b32706d8-goog
> > 
> > _______________________________________________
> > Patchwork mailing list
> > Patchwork at lists.ozlabs.org
> > https://lists.ozlabs.org/listinfo/patchwork
> _______________________________________________
> Patchwork mailing list
> Patchwork at lists.ozlabs.org
> https://lists.ozlabs.org/listinfo/patchwork