commit e51d7e84899b7116d6cb7c04265ea30f57dd25ec
author Christian Aistleitner <christian@quelltextlich.at> Sat Jul 11 17:15:34 2020 +0200
committer Christian Aistleitner <christian@quelltextlich.at> Sat Jul 11 20:05:56 2020 +0200
tree c82c158d222bc7317fcf9df06db52c789927656a
parent e75aa416f0b059faf297e8758ee221da803f96c7

Redo the `about` Documentation page

We fix the dangling links, add UI screenshots, and link to the
REST API.

Change-Id: I2884b1b4c6048eab3114cceeb3a0b5ac7f1e08c2

src/main/resources/Documentation/about.md

diff --git a/src/main/resources/Documentation/about.md b/src/main/resources/Documentation/about.md
index 19d67ec..4abe78f 100644
--- a/src/main/resources/Documentation/about.md
+++ b/src/main/resources/Documentation/about.md
@@ -1,5 +1,18 @@
-The @PLUGIN@ plugin detects Zuul [cross repository dependencies] (CRD) in
-commit messages.
+The @PLUGIN@ plugin detects Zuul [cross repository dependencies] (CRD) in
+commit messages and displays them on the Gerrit UI as "Depends on" and "Needed
+by" sections in the related changes section.
 
-[cross repository dependencies]: http://docs.openstack.org/infra/zuul/gating.html#cross-repository-dependencies
-[Cycles]: http://docs.openstack.org/infra/zuul/gating.html#cycles
+![user interface overview](images/overview.png)
+
+[Dependency cycles] (although currently only direct dependencies are considered) get highlighted
+
+![cycles screenshot](images/cycles.png)
+
+And dependencies that are not available on the server get highlighted too.
+
+![missing dependencies screenshot](images/missing.png)
+
+The cross repository dependencies are also exposed through the [REST API](rest-api-changes.html).
+
+[cross repository dependencies]: https://zuul-ci.org/docs/zuul/discussion/gating.html#cross-project-dependencies
+[Dependency cycles]: https://zuul-ci.org/docs/zuul/discussion/gating.html#cycles

src/main/resources/Documentation/images/cycles.png

diff --git a/src/main/resources/Documentation/images/cycles.png b/src/main/resources/Documentation/images/cycles.png
new file mode 100644
index 0000000..8cad8b3
--- /dev/null
+++ b/src/main/resources/Documentation/images/cycles.png
Binary files differ

src/main/resources/Documentation/images/missing.png

diff --git a/src/main/resources/Documentation/images/missing.png b/src/main/resources/Documentation/images/missing.png
new file mode 100644
index 0000000..2fc4516
--- /dev/null
+++ b/src/main/resources/Documentation/images/missing.png
Binary files differ

src/main/resources/Documentation/images/overview.png

diff --git a/src/main/resources/Documentation/images/overview.png b/src/main/resources/Documentation/images/overview.png
new file mode 100644
index 0000000..172112e
--- /dev/null
+++ b/src/main/resources/Documentation/images/overview.png
Binary files differ