README: updated the readme with the new repo content

Signed-off-by: Marc Mattmüller <marc.mattmueller@netmodule.com>
This commit is contained in:
Marc Mattmüller 2023-06-21 12:52:57 +02:00
parent 091f8f8e0d
commit 319a755428
1 changed files with 26 additions and 27 deletions

View File

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