From ee1986de8b27d260ac3c400effd52165c0cabcb1 Mon Sep 17 00:00:00 2001
From: Ahmed Ilyas <ahmed.n.ilyas@gmail.com>
Date: Fri, 29 Nov 2024 10:02:08 +0100
Subject: [PATCH] Brief documentation about nomad-distro

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/README.md b/README.md
index e69de29..7ccdbf7 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,28 @@
+## nomad-distro
+
+nomad-distro handles deployments for Central NOMAD and related environments. It allows plugin configuration, nightly updates, and manual deployments for staging and production.
+
+### Steps for Deployment
+
+1. Configure Plugins:
+
+   a. Update the plugins in pyproject.toml.
+
+   b. Generate the requirements file:
+
+```bash
+    ./scripts/generate_python_requirements.sh
+```
+
+2. Create Merge Requests (MRs):
+
+- For Central NOMAD: MR to the main branch.
+- For Test-Oasis: MR to the test-oasis branch.
+
+### Nightly Deployments (Automatic):
+
+    Updates nomad-lab package and redeploys nightly to develop and test-oasis.
+
+### Manual Deployments:
+
+    Staging/Production: Trigger manually after new releases.
-- 
GitLab