From: Stephen Finucane <stephen@that.guru>
Date: Thu, 26 Aug 2021 17:18:29 +0000 (+0100)
Subject: docs: Document the address/unaddressed comment feature
X-Git-Tag: v3.1.0~54
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=61002fc495cc09e95e29cd6c8b33c854d343a5b7;p=thirdparty%2Fpatchwork.git

docs: Document the address/unaddressed comment feature

Signed-off-by: Stephen Finucane <stephen@that.guru>
---

diff --git a/docs/usage/overview.rst b/docs/usage/overview.rst
index 273c792a..a58acfa5 100644
--- a/docs/usage/overview.rst
+++ b/docs/usage/overview.rst
@@ -71,11 +71,11 @@ Cover Letters
 ~~~~~~~~~~~~~
 
 Cover letters provide a way to offer a "big picture" overview of a series of
-patches. When using Git, these mails can be recognised by way of their `0/N`
-subject prefix, e.g. `[00/11] A sample series`. Like patches, Patchwork stores
-not only the various aspects of the cover letter itself, such as the name and
-body of the cover letter, but also various metadata associated with the email
-that the cover letter was parsed from.
+patches. When using Git, these mails can be recognised by way of their ``0/N``
+subject prefix, e.g. ``[00/11] A sample series``. Like patches, Patchwork
+stores not only the various aspects of the cover letter itself, such as the
+name and body of the cover letter, but also various metadata associated with
+the email that the cover letter was parsed from.
 
 
 Comments
@@ -181,6 +181,24 @@ system to test patches. Checks have a number of fields associated with them:
    to Patchwork.
 
 
+Comment Metadata
+----------------
+
+Like patches, Patchwork allows users to store various bits of metadata against
+comments.
+
+Action required
+~~~~~~~~~~~~~~~
+
+.. versionadded:: 3.1.0
+
+Patchwork allows users to set an "action required" flag on patch and cover
+letter comments. This flag can be set by maintainers or by the users submitting
+the cover letters. Once the submitter has provided the required information,
+either the submitter or a maintainer can mark the comment as "addressed". This
+provides a more granular way of tracking work items than patch states.
+
+
 Collections
 -----------