about summary refs log tree commit diff
path: root/modules/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'modules/README.md')
-rw-r--r--modules/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/modules/README.md b/modules/README.md
new file mode 100644
index 0000000..25031dc
--- /dev/null
+++ b/modules/README.md
@@ -0,0 +1,9 @@
+infra->modules
+==============
+
+This is all the modules used to configure our systems based on its purposes.
+
+As of now, it doesn't have any clear "naming convention", but generally it's
+`<servicename>` for a module configuring one thing, `<capability>` otherwise.
+
+e.g) `dendrite` -> `dendrite`, `prometheus`, `grafana` -> `metrics`