Change how to contribute documentation

docs/download/requirements.md

@@ -18,8 +18,8 @@ To run UNICADO, you will need some external software. It can be downloaded on th
 
 ### Required software
 
-- [:simple-python: Python :octicons-link-external-16:](https://www.python.org/) **3.11**
-- [:fontawesome-brands-java: Java Runtime Environment :octicons-link-external-16:](https://jdk.java.net/) (download zip file, unzip to e.g. `C:\Programs`, add `bin` folder of JDK to your **PATH** variable)
+- [:simple-python: Python :octicons-link-external-16:](https://www.python.org/) **3.11**. See [Install Python](../get-involved/build-instructions/build-environment/windows.md)
+- [:fontawesome-brands-java: Java Runtime Environment :octicons-link-external-16:](https://jdk.java.net/archive/) (download zip file, unzip to e.g. `C:\Programs`, add `bin` folder of JDK to your **PATH** variable)
 - [RCE :octicons-link-external-16:](https://rcenvironment.de/) integration platform (download zip file, unzip to e.g. `C:\Programs`)
 - [gnuplot :octicons-link-external-16:](https://sourceforge.net/projects/gnuplot/) for generating plots with matplot++ (download and add `bin` folder to your **PATH** variables). Gnuplot 6.0.2 is recommended!
 

docs/get-involved/build-instructions/get-source-code.md

@@ -16,51 +16,29 @@ If you are not familiar with *Git Submodules*, please read their Documentation !
 
 ## Step-by-Step Guide
 
-The repository [Unicado Package](https://git.rwth-aachen.de/unicado/unicado-package) contains all necessary source code as submodules to get started compiling **UNICADO** and its installer. It is used to create UNICADO releases and provides a good starting point for development. UNICADO project is hosted on GitLab platform. So you need to have a GitLab account if you want to fork the repsitory and start contributing to it.
+ UNICADO project is now on self hosted GitLab platform of RWTH. So you need to have write permission in the self hosted GitLab platform a GitLab if you want to create Merge Request and start contributing to it. But you can get a copy of UNICADO source code on your local machine( via cloning) and experment with it.
 
-### Step 1: Create a GitLab Account
+### Step 1: Locate the Repository You Want to Clone
 
-   - Open your browser and navigate to [GitLab:octicons-link-external-16:](https://gitlab.com/).
-   - Click on the **"Register"** button and fill in the required fields. Optionally, sign up using **Google** or **GitHub** credentials.
-   - Check your email for a confirmation link, and click on it to verify your account.
-   - Once verified, log in to your GitLab account.
+   The repository [Unicado Package](https://git.rwth-aachen.de/unicado/unicado-package) contains all necessary source code as submodules to get started compiling **UNICADO** and its installer. It is used to create UNICADO releases and provides a good starting point for development.
 
-### Step 2: Locate the Repository You Want to Fork
-
-   Search for the Unicado Package Repository: Use GitLab's **search bar** at the top of the page to find the repository. Click on the repository from the search results to view its main page.
-
-
-### Step 3: Fork the Repository
-
-  - **Click "Fork":** Find the **"Fork"** button at the top-left of the repository page.
-  - **Select Namespace:** Choose your **Personal** or **Group** namespace.
-  - **Confirm Fork:** Click **Fork project** to create your copy.
-  - **Wait for Completion:** The process will take a few moments, after which you’ll be redirected to your forked repository.
-
-Fork method is used for contributing to a GitLab project when you are not a member of the project with write access. Allows you to freely make changes to your fork and propose changes to the original repository through a merge request (MR).
-Forking Creates a personal copy of a repo on the server, the general format of forked repository is https://gitlab.com/your-username/repo.git. Now if you want to work on the repository locally using an IDE ( for eg. VSC), you need to clone the forked version of Unicado Package Repository to your locall machine. Cloning will create a local copy of Forked repository.
-
-### Step 4: Clone Your Forked Repository
-
-  - **Navigate to Your Fork:** Navigate to your forked repository in the GitLab dashboard under Projects.
+### Step 2: Clone the Repository
 
   - **Copy the Clone URL:** Click the Clone button and choose HTTPS or SSH.
 
   -  **Clone the Repository Locally:**
 
-
-
 === "HTTP"
 
     ``` { .cmd .copy }
-    git clone https://gitlab.com/your-username/repository-name.git
+    git clone https://git.rwth-aachen.de/unicado/unicado-package.git
     ```
 
 
 === "SSH"
 
     ``` { .sh .copy }
-    git clone git@gitlab.com:your-username/repository-name.git
+    git clone git@git.rwth-aachen.de:unicado/unicado-package.git
     ```
 
 Should the default branch not yet contain the submodules or you want to update the submodules afterwards, you can do that with:
@@ -71,16 +49,16 @@ Should the default branch not yet contain the submodules or you want to update t
 
 
 !!! Note
-   You can push to a forked repository without configuring SSH by using HTTPS for authentication instead of SSH. However, SSH is often preferred for its security and ease of use once set up. 🎥**Follow [SSH Configuration](../how-to-contribute/contributor-tutorial/videos/SSH_Configuration.mp4) tutorial video if you want to set up SSH**.
+   You can push to a cloned repository without configuring SSH by using HTTPS for authentication instead of SSH. However, SSH is often preferred for its security and ease of use once set up. 🎥**Follow [SSH Configuration](../how-to-contribute/contributor-tutorial/videos/SSH_Configuration.mp4) tutorial video if you want to set up SSH**.
 
 !!! Attention
    Only proceed when all submodules could be checked out successfully. Otherwise the builds will not work!
 
-In the following instructions we assume, that you forked and cloned the **Unicado Package** as described.
+In the following instructions we assume, that you have cloned the **Unicado Package** as described.
 That means, whenever we talk about building inside the *Aircraft Design* folder, we mean the submodule **inside** the **Unicado Package** repository.
 In general, you should find every mentioned directory or file in one of the submodules of the **Unicado Package**. :point_up:
 
-### Step 5: Update the Repository with the Latest Changes from Remote
+### Step 3: Update the Repository with the Latest Changes from Remote
 
 Once the repository is cloned, you need to update it with the latest changes from the remote. If your repository includes multiple submodules, follow these steps:
 

docs/get-involved/how-to-contribute/contribute.md

@@ -9,6 +9,8 @@ date: 2024-03-05
 
 You want to contribute to UNICADO?
 
+Merge Request's are the way to contribute to any project hosted on GitLab platform. Currently UNICADO project is hosted on self hosted GitLab platform on RWTH server and only project members with right access can contribute to the project. If you have write access ( If not, please contact the admins of the project.) , follow the below guidelines to create an MR.
+
 Awesome! :sunglasses: Please make sure to read our *style guides* first:
 
 - Our [⤷ C++ Code Style](../style/cpp.md).
@@ -19,13 +21,33 @@ Awesome! :sunglasses: Please make sure to read our *style guides* first:
 This is how you can actually make a difference:
 The flowchart below illustrates the Merge Request workflow, along with the commands used at each stage.
 
+graph TD;
+    A[Create Feature Branch] -->|git checkout -b feature-branch| B[Make Changes & Commit];
+    B -->|git add . & git commit -m "message"| C[Push to Remote Repository];
+    C -->|git push origin feature-branch| D[Open Merge Request in GitLab];
+    D -->|Select source & target branch| E[Assign Reviewers & Add Description];
+    E --> F[Code Review & Discussion];
+    F -->|Comments & Fixes| G[Push Updates if Needed];
+    G --> H[Run CI/CD Pipeline];
+    H -->|Tests Pass?| I{Success?};
+    I -- No -->|Fix Issues & Push Again| G;
+    I -- Yes --> J[Approvals & Final Review];
+    J -->|Code Standards & Security Checks| K[Merge the Request];
+    K -->|Select Merge Strategy| L[Delete Feature Branch (Optional)];
+    L --> M[Pull Latest Changes];
+    M --> N[Deployment via CI/CD (If Configured)];
+    N --> O[Merge Process Complete! 🎉];
+
+
+
+
 <figure>
   <img src="site:assets/images/merge_request_workflow.png" alt="merge-request" style="width: 80%; height: auto;" >
   <figcaption>Merge request workflow</figcaption>
 </figure>
 
 
-You cloned/forked the UNICADO Package successfully acc. to [Get Source Code](../build-instructions/get-source-code.md). Nice! You want to make a change, e.g. fixing a bug or creating a new feature, so you create a *issue* (see also [types of contribution](#contributions)). Then you :point_up: create a feature branch, change the code and create a merge request (here a [how to](merge-request.md)). An automatic CI/CD pipeline is triggered, which helps your selected reviewer to make sure that request is ok. If it is accepted and ready-to-land :airplane:, the documentation is automatically updated. Nicely done :+1:
+You cloned the UNICADO Package successfully acc. to [Get Source Code](../build-instructions/get-source-code.md). Nice! You want to make a change, e.g. fixing a bug or creating a new feature, so you create a *issue* (see also [types of contribution](#contributions)). Then you :point_up: create a feature branch, change the code and create a merge request (here a [how to](merge-request.md)). An automatic CI/CD pipeline is triggered, which helps your selected reviewer to make sure that request is ok. If it is accepted and ready-to-land :airplane:, the documentation is automatically updated. Nicely done :+1:
 
 ## Types of contribution {#contributions}