Update README and Writerside docs

Quiirex · Jun 29, 2024 · 7a7ed2b · 7a7ed2b
1 parent 7750d2d
commit 7a7ed2b
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 [![CI/CD Pipeline](https://github.com/Quiirex/testops_poc/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/Quiirex/testops_poc/actions/workflows/ci-cd.yml)
 
-# TestOps - PoC
+# TestOps integration PoC
 
-This is a PoC which demonstrates integrating TestOps practices and tools in the CI/CD pipeline.
+This Proof of Concept (PoC) is proposed in my master's thesis to demonstrate the integration of TestOps practices and tools within the CI/CD pipeline of an application.
 
-Documention for the PoC is [available here](https://quiirex.github.io/testops_poc/)
+Documention of the PoC is [available here](https://quiirex.github.io/testops_poc/)
diff --git a/Writerside/hi.tree b/Writerside/hi.tree
@@ -3,7 +3,7 @@
         SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
 
 <instance-profile id="hi"
-                 name="Help instance"
+                 name="TestOps PoC documentation"
                  start-page="TestOps-Proof-of-Concept.md">
 
     <toc-element topic="TestOps-Proof-of-Concept.md"/>

diff --git a/Writerside/topics/Best-Practices.md b/Writerside/topics/Best-Practices.md
@@ -1,6 +1,6 @@
 # Best Practices
 
-The following good practices have been taken into account in the implementation of the CI/CD pipeline:
+The following best practices have been taken into account in the implementation of the CI/CD pipeline:
 - **Isolation of environments**: the use of containerisation ensures that all environments (development, testing, production) are consistent and isolated.
 - **Transparent documentation**: each step in the pipeline is clearly documented, making it easy for other team members to understand and adapt the process.
 - **Communication and reporting**: at the end of each pipeline run, we are informed of the result of the pipeline via email (this needs to be enabled in your GitHub account settings), allowing the development team to react in a timely manner.

diff --git a/Writerside/topics/The-CI-CD-Pipeline.md b/Writerside/topics/The-CI-CD-Pipeline.md
@@ -18,7 +18,7 @@ The pipeline is designed to be extensible, allowing for an unlimited number of a
 ## The Architecture
 
 Below is the image of the proposed CI/CD Pipeline Architecture which includes TestOps strategies and tools.
-![Pipeline Architecture](Pipeline-Architecture.png)
+![Pipeline Architecture](Pipeline-Architecture.png) {width="550"}
 
 ## Pipeline Steps