From fa2766e64a1bb5e298ebf0c7d736d28bcffd7c6a Mon Sep 17 00:00:00 2001
From: Tim Jaacks <tim.jaacks@seco.com>
Date: Fri, 21 Jul 2023 10:59:55 +0200
Subject: [PATCH] README: review documentation for adding new project

---
 docs/add-new-project-to-pipeline.md | 36 +++++++++++++++--------------
 1 file changed, 19 insertions(+), 17 deletions(-)

diff --git a/docs/add-new-project-to-pipeline.md b/docs/add-new-project-to-pipeline.md
index b424256d..191f9313 100644
--- a/docs/add-new-project-to-pipeline.md
+++ b/docs/add-new-project-to-pipeline.md
@@ -37,25 +37,27 @@ In the gitlab UI use the settings:
 
 `Settings->CI/CD`:
 
-* *Variables*: Add a variable `INTEGRATION`, that specifies the which branch of
-               this project should be integrated into which branch of the yocto.
-               for example: `main:seco-ne/yocto/manifest:kirkstone`
-               `main`: The default branch of the new project.
-               `seco-ne/yocto/manifest`: The path to the manifest of the yocto 
-                                         project. This might differ for custom
-                                         layers. 
-               `kirkstone`: The branch of the yocto manifest to be used for the
-                            integration.
-               There may be more lines then only one, to integrate into several
-               yoctos or branches.
+* *Variables*: Add a variable `INTEGRATION` that specifies which branch of this
+  project should be integrated into which branch of the yocto manifest.
+
+  Example: `main:seco-ne/yocto/manifest:kirkstone`
+  
+  * `main`: The default branch of the new project.
+  * `seco-ne/yocto/manifest`: The path to the manifest of the yocto project.
+                              This might differ for custom layers.
+  * `kirkstone`: The branch of the yocto manifest to be used for the
+                 integration.
+
+  There may be multiple lines in the `INTEGRATION` variable to integrate into
+  several manifests or branches.
 
 ## Add the new project to the yocto project
 
 ### Project referenced by recipe
 
-This part is relevant, if the new repo should be used by a recipe as new package.
+This part is relevant if the new repo should be used by a recipe as new package.
 
-Create a new recipe in one of the layers used by the yocto project like 
+Create a new recipe in one of the layers used by the yocto project like
 `<new-project.bb>`:
 
 ```
@@ -83,18 +85,18 @@ It needs a new line for the new project like:
 SRCREV:pn-<new-project> = "<current hash>"
 ```
 
-### New layer 
+### New layer
 
-This part is relevant, if the new repo should be used by a yocot layer.
+This part is relevant if the new repo shall be used by a yocto layer.
 
 *TODO*
 
 
 ## Add the CI code to the new project
 
-### Add submodule .gitlab-ci 
+### Add submodule .gitlab-ci
 
-The submodule need to be added with a relative path.
+The submodule needs to be added with a relative path.
 
 ```
 git submodule add ../../yocto/infrastructure/gitlab-ci.git .gitlab-ci
-- 
GitLab