docs: document infra-smoke-tests

rust-lang · Oct 14, 2024 · 753a3e3 · 753a3e3
1 parent 470619c
commit 753a3e3
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/service-catalog/infra-smoke-tests/README.md b/service-catalog/infra-smoke-tests/README.md
@@ -0,0 +1,12 @@
+# Infra smoke tests
+
+The [infra-smoke-tests] repository contains a set of tests that are run against
+the infrastructure to ensure that it is working as expected.
+
+Use cases:
+
+- Check if there's an ongoing incident.
+- Ensure that modification to the infrastructure (e.g. `terraoform apply`)
+  worked as expected.
+
+[infra-smoke-tests]: https://github.com/rust-lang/infra-smoke-tests