Document the functionality of the find-owners plugin
Add a brief overview of the functionality that is offered by the
find-owners plugin.
Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: Ibbd26f3da1212464f33eb325edda22a9edb4bd9d
diff --git a/resources/Documentation/alternative-plugins.md b/resources/Documentation/alternative-plugins.md
index b335414..b158c8c 100644
--- a/resources/Documentation/alternative-plugins.md
+++ b/resources/Documentation/alternative-plugins.md
@@ -1,10 +1,51 @@
# Alternative Plugins
-Similar functionality is provided by the
-[find-owners](https://gerrit-review.googlesource.com/admin/repos/plugins/find-owners)
-plugin and the
-[owners](https://gerrit-review.googlesource.com/admin/repos/plugins/owners)
-plugin.
+Similar functionality is provided by the following plugins:
+
+* [find-owners](#findOwners) plugin
+* [owners](https://gerrit-review.googlesource.com/admin/repos/plugins/owners)
+ plugin
+
+## <a id="findOwners">find-owners plugin (deprecated)
+
+**Status:** deprecated, from Gerrit 3.4 on the `code-owners` plugin should be used instead\
+**Repository:** [plugins/find-owners](https://gerrit-review.googlesource.com/admin/repos/plugins/find-owners)\
+**Documentation:** [about](https://gerrit.googlesource.com/plugins/find-owners/+/master/src/main/resources/Documentation/about.md), [syntax](https://gerrit.googlesource.com/plugins/find-owners/+/master/src/main/resources/Documentation/syntax.md), [REST API](https://gerrit.googlesource.com/plugins/find-owners/+/master/src/main/resources/Documentation/rest-api.md), [config](https://gerrit.googlesource.com/plugins/find-owners/+/master/src/main/resources/Documentation/config.md)
+
+### <a id="findOwnersFunctionality">Functionality
+
+* Basic support for defining code owners:
+ * Code owners can be specified in `OWNERS` files that can appear in any
+ directory in the source branch.
+ * Code owners can be specified by email.
+ * Inheritance from parent directories is supported and can be disabled.
+ * Including an `OWNERS` file from another directory in the same project or
+ from another project on the same host is possible (same branch is assumed).
+ * File globs can be used.
+ * See [documentation](https://gerrit.googlesource.com/plugins/find-owners/+/master/src/main/resources/Documentation/syntax.md) for the supported syntax.
+<br><br>
+* Prolog rule to prevent submitting changes without owner approvals.
+ * A change can be exempted from owners approval by setting a footer in the
+ commit message.
+<br><br>
+* Basic UI:
+ * Supports to discover users that can grant owner approval on a change
+ (weighed suggestion) and add them as reviewer to the change.
+ * Missing owner approvals are visualized on a change.
+ * Owner approval is granted by voting on the `Code-Review` label.
+<br><br>
+* REST endpoints:
+ * [Action](https://gerrit.googlesource.com/plugins/find-owners/+/master/src/main/java/com/googlesource/gerrit/plugins/findowners/Action.java) REST endpoint:
+ * `GET /changes/<change-id>/revisions/<revision-id>/find-owners`
+ * returns a [RestResult](https://gerrit.googlesource.com/plugins/find-owners/+/master/src/main/java/com/googlesource/gerrit/plugins/findowners/RestResult.java) which contains:
+ * a file to list of owners map
+ * a list of owner infos with weight infos
+ * fields for debugging
+ * fields for change, patch set, current reviewers and changed files
+ * [GetOwners](https://gerrit.googlesource.com/plugins/find-owners/+/master/src/main/java/com/googlesource/gerrit/plugins/findowners/GetOwners.java) REST endpoint:
+ * `GET /changes/<change-id>/owners`
+ * 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)
---
