From 319a755428c118b85041e5fbc0434e85354ff276 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marc=20Mattm=C3=BCller?= <marc.mattmueller@netmodule.com>
Date: Wed, 21 Jun 2023 12:52:57 +0200
Subject: [PATCH] README: updated the readme with the new repo content
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Marc Mattmüller <marc.mattmueller@netmodule.com>
---
 README.md | 53 ++++++++++++++++++++++++++---------------------------
 1 file changed, 26 insertions(+), 27 deletions(-)

diff --git a/README.md b/README.md
index d0c381c..11cbc70 100644
--- a/README.md
+++ b/README.md
@@ -4,35 +4,34 @@ NetModule Wireless Linux (NWL).
 
 
 ## Content
-This repository holds the documentation for the CI environment and the jobs for
-the NWL as declarative pipelines (multibranch):
+This repository holds the automation files for ansible, the CI environment for
+the NWL and its documentation:
 
 * doc
-
-   - the documentation of the work for the NWL CI environment
-
-* jobs
-
-   - Jenkinsfile_Build
-
-      + a pipeline building a NWL yocto target
-
-   - Jenkinsfile_Common
-
-      + a collection of commonly used functions, so that duplicated code can be
-        avoided
-
-* inventory
-
-   - Ansible inventory with all managed hosts/devices
-
-* playbooks
-
-   - Ansible playbooks
-
-
-## Marginal Notes
-This repository does NOT cover the setup of the Jenkins instance.
+    - the documentation of the work for the NWL CI environment
+* ansible automation:
+    - ansible.cfg
+        + the paths of inventory, collections, etc for AWX
+    - inventory
+        + the ansible inventory with all managed hosts/devices
+    - playbooks
+        + ansible playbooks
+* jenkins environment:
+    - jobs
+        + Jenkinsfile_Common
+            - a collection of commonly used functions, so that duplicated code
+              can be avoided
+        + Jenkinsfile_Build / Jenkinsfile_Build_awx
+            - a pipeline building a NWL yocto target (postfix awx is for the
+              instance set up with AWX)
+        + Jenkinsfile_Documentation_awx
+            - a pipeline building the CI documentation (for the instance set up
+              with AWX)
+    - docker
+        + Dockerfile
+        + nwl-cicd.yaml
+        + plugins.txt
+    - docker-compose.yaml
 
 
 ## Building the Documentation