From bc52ec8c3d1a31902bc5510f2ec807c8a5f59508 Mon Sep 17 00:00:00 2001
From: MarcoIeni <11428655+MarcoIeni@users.noreply.github.com>
Date: Tue, 24 Sep 2024 18:36:24 +0200
Subject: [PATCH] docs: document rust-log-analyzer

---
 service-catalog/rust-log-analyzer/README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 service-catalog/rust-log-analyzer/README.md

diff --git a/service-catalog/rust-log-analyzer/README.md b/service-catalog/rust-log-analyzer/README.md
new file mode 100644
index 0000000..4be766c
--- /dev/null
+++ b/service-catalog/rust-log-analyzer/README.md
@@ -0,0 +1,20 @@
+# Rust Log Analyzer
+
+[rust-log-analyzer] is a tool that analyzes the CI build logs of the [rust] repository to automatically extract error messages from failed builds.
+
+This tool is deployed via the [terraform/rust-log-analyzer] module as an ECS service and uses S3 to store the GitHub actions index.
+
+## Versions
+
+These are the versions we need to keep up-to-date:
+
+- Ubuntu version in the [Dockerfile]
+- Dependencies in [Cargo.lock]
+- GitHub Actions versions in the [workflows]
+
+[Cargo.lock]: https://github.com/rust-lang/rust-log-analyzer/blob/master/Cargo.lock
+[Dockerfile]: https://github.com/rust-lang/rust-log-analyzer/blob/master/Dockerfile
+[rust-log-analyzer]: https://github.com/rust-lang/rust-log-analyzer
+[rust]: https://github.com/rust-lang/rust
+[terraform/rust-log-analyzer]: https://github.com/rust-lang/simpleinfra/tree/master/terraform/rust-log-analyzer
+[workflows]: https://github.com/rust-lang/rust-log-analyzer/tree/master/.github/workflows