Document for the find-owners backend that code owners are defined in OWNERS files
Start a new page for the find-owners backend. In follow-up changes we
will add further information to it (e.g. an explanation of the syntax).
Signed-off-by: Edwin Kempin <[email protected]>
Change-Id: I27e00ade964a99ef2088376fbc7e698139b2392b
diff --git a/resources/Documentation/backend-find-owners.md b/resources/Documentation/backend-find-owners.md
new file mode 100644
index 0000000..0872582
--- /dev/null
+++ b/resources/Documentation/backend-find-owners.md
@@ -0,0 +1,26 @@
+# find-owners Backend
+
+The `find-owners` backend supports the syntax of the
+[find-owners](https://gerrit-review.googlesource.com/admin/repos/plugins/find-owners)
+plugin (with some minor extensions). It is the backend that is used by default
+if no other backend is explicitly [configured](config.html#codeOwnersBackend)
+for a project or branch.
+
+## Code owner configuration
+
+Code owners are defined in `OWNERS` files which are stored in the source tree.
+The code owners that are defined in an `OWNERS` file apply to the directory that
+contains the `OWNERS` file, and all its subdirectories (except if a subdirectory
+contains an `OWNERS` file that disables the inheritance of code owners from the
+parent directories).
+
+**NOTE:** It's possible that projects have a [file extension for code owner
+config files](config.html#codeOwnersFileExtension) configured. In this case the
+code owners are defined in `OWNERS.<file-extension>` files and `OWNERS` files
+are ignored.
+
+---
+
+Back to [@PLUGIN@ documentation index](index.html)
+
+Part of [Gerrit Code Review](../../../Documentation/index.html)
diff --git a/resources/Documentation/backends.md b/resources/Documentation/backends.md
index fd380b4..40d5550 100644
--- a/resources/Documentation/backends.md
+++ b/resources/Documentation/backends.md
@@ -2,15 +2,14 @@
The following code owner backends are supported:
-* `find-owners`:
- Code owner backend that supports the syntax of the
- [find-owners](https://gerrit-review.googlesource.com/admin/repos/plugins/find-owners)
- plugin.
+* [find-owners](backend-find-owners.html):
+ Code owner backend that supports the syntax of the
+ [find-owners](https://gerrit-review.googlesource.com/admin/repos/plugins/find-owners)
+ plugin.
* `proto`:
- Code owner backend that supports a proto-based syntax. The proto syntax is
- not final yet and backwards incompatible changes are likely to happen. This
- is why this backend is experimental for now and should not be used in
- production.
+ Code owner backend that supports a proto-based syntax. The proto syntax is not
+ final yet and backwards incompatible changes are likely to happen. This is why
+ this backend is experimental for now and should not be used in production.
---
