Explain on the about page when the code-owners plugin should/shouldn't be used This is already explained in the how to use guide, but users often miss this information there. The about page is the entry page of the code-owners documentation (it is integrated as the first section into the index page) and what users that are interested in using the code-owners plugin read first, hence users are unlikely to miss this information here. Change-Id: Ie3800fd96eadcbcaa97f610398f911b4a1db25b3 Signed-off-by: Edwin Kempin <ekempin@google.com> Reviewed-on: https://gerrit-review.googlesource.com/c/plugins/code-owners/+/409498 Tested-by: Zuul <zuul-63@gerritcodereview-ci.iam.gserviceaccount.com> Reviewed-by: Nitzan Gur-Furman <nitzan@google.com>
diff --git a/resources/Documentation/about.md b/resources/Documentation/about.md index fecbc41..1db9847 100644 --- a/resources/Documentation/about.md +++ b/resources/Documentation/about.md
@@ -8,6 +8,12 @@ An overview of the supported features can be found [here](feature-set.html). +**IMPORTANT:** Using the @PLUGIN@ plugin is recommended only for repositories +that contain files / folders that are owned by different users. If this is not +the case, and all files / folders in the repository are owned by the same users +[plain Gerrit permissions should be preferred +instead](config-guide.html#configureCodeOwnersByPermissions). + **IMPORTANT:** Before installing/enabling the plugin, or enabling the code owners functionality for further projects, follow the instructions from the [setup guide](setup-guide.html).