Document the functionality of the owners plugin
Add a brief overview of the functionality that is offered by the owners
plugin.
Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: I7bc5d74922f2b7eb7dc82a6c551d8394637ac79f
diff --git a/resources/Documentation/alternative-plugins.md b/resources/Documentation/alternative-plugins.md
index 8426f17..296e4d7 100644
--- a/resources/Documentation/alternative-plugins.md
+++ b/resources/Documentation/alternative-plugins.md
@@ -3,8 +3,7 @@
Similar functionality is provided by the following plugins:
* [find-owners](#findOwners) plugin
-* [owners](https://gerrit-review.googlesource.com/admin/repos/plugins/owners)
- plugin
+* [owners](#owners) plugin
## <a id="findOwners">find-owners plugin (deprecated)
@@ -65,6 +64,36 @@
* Delegates to Action REST endpoint (see above)
* Also see [REST endpoint documentation](https://gerrit.googlesource.com/plugins/find-owners/+/master/src/main/resources/Documentation/rest-api.md)
+## <a id="owners">owners plugin + owners-autoassign plugin
+
+**Status:** maintained by the Gerrit open source community (no Google involvement)\
+**Repository:** [plugins/owners](https://gerrit-review.googlesource.com/admin/repos/plugins/owners)\
+**Documentation:** [readme](https://gerrit.googlesource.com/plugins/owners/+/master/README.md), [config & syntax](https://gerrit.googlesource.com/plugins/owners/+/master/owners/src/main/resources/Documentation/config.md)
+
+### <a id="ownersFunctionality">Functionality
+
+* Basic support for defining code owners in the source branch and globally for
+ a repository:
+ * Code owners can be specified in `OWNERS` files that can appear in any
+ directory in the source branch.
+ * Code owners can be specified on repository level by an `OWNERS` file in
+ the `refs/meta/config` branch.
+ * Code owners can be specified by email or full name.
+ * Groups can be specified as code owners (by group name and group UUID).
+ * Inheritance from parent directories is supported and can be disabled.
+ * Regular expressions can be used.
+ * Syntax is based on YAML.
+ * See [documentation](https://gerrit.googlesource.com/plugins/owners/+/master/owners/src/main/resources/Documentation/config.md) for the supported syntax.
+<br><br>
+* Prolog rule to prevent submitting changes without code owner approvals.
+ * The label on which code owners must vote is configurable.
+<br><br>
+* The UI visualizes whose approval is needed for submit.
+ * Implemented by the `need` description of the Prolog rule, which will be
+ shown in the UI (the plugin doesn't contain any UI code)
+<br><br>
+* Auto-adding of code owners as reviewers.
+
---
Back to [@PLUGIN@ documentation index](index.html)
