Merge pull request #366 from caffeine-rohit/DevSec1

Closes #363

Author: wurstbrot

Development.md

@@ -1,46 +1,72 @@
-# DSOMM
+# DevSecOps Maturity Model (DSOMM)
+
+## Introduction
+
+The DevSecOps Maturity Model (DSOMM) is an open-source framework designed to help organizations evaluate and improve their **DevSecOps** practices.  
+It provides structured **security maturity levels**, recommendations, and automation insights to enable teams to build **secure, efficient, and scalable software**.
+
+This guide walks you through **setting up the project locally**, making contributions, and submitting a pull request.
+
+## **Project Setup**
+
+### Development Server
 
-## Development server
 The DSOMM is based [Angular](https://angular.dev/) and uses npm for package management.
+
 - If you have not yet installed npm or the Angular command line tools, install them now. First [NodeJS](https://nodejs.org/en/download) (which provides npm), then Angular:
-``` 
+
+```bash
 npm install -g @angular/cli
-``` 
-- Clone the DSOMM repo
 ```
+
+- Clone the DSOMM repo
+
+```bash
 git clone https://github.com/devsecopsmaturitymodel/DevSecOps-MaturityModel.git
 ```
+
 - Change directory to DSOMM
-```
+
+```bash
 cd DevSecOps-MaturityModel
 ```
+
 - Install Dependencies
-```
+
+```bash
 npm install
 ```
+
 - **NB!** The DSOMM activities are maintained separately. Download the `generated.yaml` and put it in the required folder
-```
+
+```bash
 curl https://raw.githubusercontent.com/devsecopsmaturitymodel/DevSecOps-MaturityModel-data/main/src/assets/YAML/generated/generated.yaml -o src/assets/YAML/generated/generated.yaml
 ```
 
 - Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
 
-
-## Code scaffolding
+## Code Scaffolding
 
 Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
 
 ## Build
 
 Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
 
-## Running unit tests
+## Running Unit Tests
 
 Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
 
 ## Coding Style Conventions
 
-- We follow the coding style defined by [ESLint](https://eslint.org/). 
+- We follow the coding style defined by [ESLint](https://eslint.org/).
 - We also use [Prettier](https://prettier.io/docs/en/index.html) as our opinionated code formatter.
-- To validate the schemas of the DSOMM yaml files in the IDE, it is recommended to use the VS Code extension [redhat.vscode-yaml](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml). The schemas are stored in /src/assets/YAML/schemas
+- To validate the schemas of the DSOMM yaml files in the IDE, it is recommended to use the VS Code extension [redhat.vscode-yaml](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml). The schemas are stored in `/src/assets/YAML/schemas`
+
+### Running Linter
+
+Run `ng lint` to run the linter from the command line.  
+If you want to lint only a specific component, use:
 
+```bash
+ng lint --lint-file-patterns .\src\app\component\xxxxxx\

README.md

@@ -94,6 +94,29 @@ service docker start
 docker run -d -p 80:8080 wurstbrot/dsomm:latest
 ```
 
+## Generating the `generated.yaml` File
+
+The `generated.yaml` file is dynamically created during the build process. If you don’t see this file after setup, follow these steps to generate it:
+
+**1. Clone the Required Repository:**
+The `generated.yaml` file is built via the DevSecOps-MaturityModel-data repository. Make sure you have cloned and set it up correctly.
+
+**2. Run the Build Command:**
+Navigate to the project directory and run the following command:
+- *Using npm:*
+
+```sh
+npm run build
+````
+
+- *Using yarn:*
+
+```sh
+yarn build
+```
+
+*If the file is missing, ensure all dependencies are installed and that you have the correct access to the `DevSecOps-MaturityModel-data` repository.*
+
 ## Activity Definitions
 The definition of the activities are in the [data-repository](https://github.com/devsecopsmaturitymodel/DevSecOps-MaturityModel-data). 
 

src/assets/YAML/generated/README.md

@@ -1 +1,11 @@
-In this folder, the generated.yaml will be placed
+# Generated YAML Files
+
+This folder contains the `generated.yaml` file, which is dynamically created during the build process.  
+It stores configuration settings and other automatically generated data used by the DevSecOps Maturity Model (DSOMM).  
+
+## **What is `generated.yaml`?**
+
+- It is a machine-generated file that is **not meant to be manually edited**.
+- It helps in **storing configuration settings**, which are loaded at runtime.
+- Used by the application to dynamically configure settings.
+- This file is generated via the [DevSecOps-MaturityModel-data](https://github.com/devsecopsmaturitymodel/DevSecOps-MaturityModel-data) repository.