Document the compatibility with the find-owners plugin This helps admins to understand what it means to migrate from the find-owners plugin to the code-owners plugin. Signed-off-by: Edwin Kempin <ekempin@google.com> Change-Id: Ic5e2f1640b6c2de6072a6f89af91f782989c8f26
diff --git a/resources/Documentation/alternative-plugins.md b/resources/Documentation/alternative-plugins.md index b158c8c..8426f17 100644 --- a/resources/Documentation/alternative-plugins.md +++ b/resources/Documentation/alternative-plugins.md
@@ -12,6 +12,24 @@ **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="findOwnersCompatibility">Compatibility with the code-owners plugin + +The [find-owners](backend-find-owners.html) backend in the`code-owners` plugin +supports the same syntax for `OWNERS` files as the `find-owners` plugin. This +means that existing `OWNERS` files continue to work with the `code-owners` +plugin and no migration for the `OWNERS` files is required. + +**IMPORTANT:** When migrating to the `code-owners` plugin, make sure that it is +correctly configured (see [setup guide](setup-guide.html)). + +**NOTE:** The REST API of the `code-owners` plugin is completely different than +the REST API of the `find-owners` plugin. This means callers of the REST API +must be adapted to the new API. + +**NOTE:** The `OWNERS` syntax in the `code-owners` plugin supports some +additional features. This means that `OWNERS` files that work with the +`code-owners` plugin may not work with the `find-owners` plugin. + ### <a id="findOwnersFunctionality">Functionality * Basic support for defining code owners: