# thehackingproject/devops-introduction architecture

> Architecture diagram of the GitHub repository thehackingproject/devops-introduction, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-11). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/thehackingproject/devops-introduction
- Repository: https://github.com/thehackingproject/devops-introduction

## Overview

##### Main Components
- Repository Root – This is the entry point and includes the overall README, a shell script (first_script.sh), and the assets folder.
- Assets Module – A dedicated folder containing sample lesson and project markdown files (e.g., lesson_example.md and project_example.md) that serve as templates or examples.
- Weekly Modules – Each week is a top-level folder (week_01, week_02, week_03, etc.). They represent the course outline by week.
- Daily Submodules – Inside each weekly folder, there are day folders (day_01 to day_05). Every day folder includes:
– day_title.txt and day_presentation.txt files, containing the title and overview for the day.
– Markdown lessons (lesson_XX.md) and project briefs (project_XX.md). In some cases, there are correction guidelines (correction_guidelines.txt) located on a day that is used for post-project correction.
- Supplementary Scripts – For instance, first_script.sh might assist in automating some workflow related to the content (for example, preparing or deploying updated materials).

##### Relationships and Data Flow
- The README at the root provides complete guidance on how the whole repository is structured and how the individual pieces interact.
- Each Week folder aggregates the daily content for that period. Within each week, the day folders are sequenced to define the learning journey from introduction (titles, presentations) to practical tasks (projects and lessons).
- The correction guidelines file (where it exists) belongs to the project validation cycle and is used to feed back into the learning loop.
- The weekly structure (signified by a week_title.txt and week_presentation.txt) acts as a high-level organizer that critically connects to each day’s learning objectives.

##### Architectural Patterns and Principles
- Consistency and Modularity – Each week and day follows a consistent file naming and contents pattern, demonstrating a modular approach to curricular content.
- Content-Driven Flow – The flow heavily revolves around the progression of learning, starting from introductory guidelines (in the README and assets) down to the detailed daily instructions and projects.

##### Important Architectural Elements to Capture
- The top-level structure showing the separation (e.g., “Global Docs”, “Assets”, “Weeks”).
- The recurrence of a structural template across weeks and days.
- The dual nature of projects: resource examples (in assets) and actual project tasks (in each day folder).
- The design decision to couple learning resources with practical, project-driven content.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Project Repository – The Hacking Project Content Hub"
        
        %% Global Documentation & Scripts
        subgraph "Global Documentation & Scripts"
            README["README.md"]:::globalDocs
            SCRIPT["first_script.sh"]:::globalDocs
        end

        %% Assets Module
        subgraph "Assets – Lesson/Project Templates"
            ASSET["assets (folder)"]:::assets
            LessonExample["lesson_example.md"]:::assets
            ProjectExample["project_example.md"]:::assets
            ASSET --> LessonExample
            ASSET --> ProjectExample
        end

        %% Weekly Modules
        subgraph "Weekly Modules"
            %% Week 01 Module
            subgraph "Week 01 Module"
                Week01Folder["Folder: Week_01/"]:::weekModules
                Week01Title["week_title.txt"]:::weekModules
                Week01Pres["week_presentation.txt"]:::weekModules
                Week01Folder --> Week01Title
                Week01Folder --> Week01Pres
                subgraph "Day Modules"
                    Week01Day01["Day Module: Day_01"]:::dayModules
                    Week01Day02["Day Module: Day_02"]:::dayModules
                    Week01Day03["Day Module: Day_03"]:::dayModules
                    Week01Day04["Day Module: Day_04"]:::dayModules
                    Week01Day05["Day Module: Day_05"]:::dayModules
                end
                Week01Title --> Week01Day01
                Week01Title --> Week01Day02
                Week01Title --> Week01Day03
                Week01Title --> Week01Day04
                Week01Title --> Week01Day05
            end

            %% Week 02 Module
            subgraph "Week 02 Module"
                Week02Folder["Folder: Week_02/"]:::weekModules
                Week02Title["week_title.txt"]:::weekModules
                Week02Pres["week_presentation.txt"]:::weekModules
                Week02Folder --> Week02Title
                Week02Folder --> Week02Pres
                subgraph "Day Modules"
                    Week02Day01["Day Module: Day_01"]:::dayModules
                    Week02Day02["Day Module: Day_02"]:::dayModules
                    Week02Day03["Day Module: Day_03"]:::dayModules
                    Week02Day04["Day Module: Day_04"]:::dayModules
                    Week02Day05["Day Module: Day_05"]:::dayModules
                end
                Week02Title --> Week02Day01
                Week02Title --> Week02Day02
                Week02Title --> Week02Day03
                Week02Title --> Week02Day04
                Week02Title --> Week02Day05
            end

            %% Week 03 Module
            subgraph "Week 03 Module"
                Week03Folder["Folder: Week_03/"]:::weekModules
                Week03Title["week_title.txt"]:::weekModules
                Week03Pres["week_presentation.txt"]:::weekModules
                Week03Folder --> Week03Title
                Week03Folder --> Week03Pres
                subgraph "Day Modules"
                    Week03Day01["Day Module: Day_01"]:::dayModules
                    Week03Day02["Day Module: Day_02"]:::dayModules
                    Week03Day03["Day Module: Day_03"]:::dayModules
                    Week03Day04["Day Module: Day_04"]:::dayModules
                    Week03Day05["Day Module: Day_05"]:::dayModules
                end
                Week03Title --> Week03Day01
                Week03Title --> Week03Day02
                Week03Title --> Week03Day03
                Week03Title --> Week03Day04
                Week03Title --> Week03Day05
            end

            %% Week 04 Module
            subgraph "Week 04 Module"
                Week04Folder["Folder: Week_04/"]:::weekModules
                Week04Title["week_title.txt"]:::weekModules
                Week04Pres["week_presentation.txt"]:::weekModules
                Week04Folder --> Week04Title
                Week04Folder --> Week04Pres
                subgraph "Day Modules"
                    Week04Day01["Day Module: Day_01"]:::dayModules
                    Week04Day02["Day Module: Day_02"]:::dayModules
                    Week04Day03["Day Module: Day_03"]:::dayModules
                    Week04Day04["Day Module: Day_04"]:::dayModules
                    Week04Day05["Day Module: Day_05"]:::dayModules
                end
                Week04Title --> Week04Day01
                Week04Title --> Week04Day02
                Week04Title --> Week04Day03
                Week04Title --> Week04Day04
                Week04Title --> Week04Day05
            end

            %% Week 05 Module
            subgraph "Week 05 Module"
                Week05Folder["Folder: Week_05/"]:::weekModules
                Week05Title["week_title.txt"]:::weekModules
                Week05Pres["week_presentation.txt"]:::weekModules
                Week05Folder --> Week05Title
                Week05Folder --> Week05Pres
                subgraph "Day Modules"
                    Week05Day01["Day Module: Day_01"]:::dayModules
                    Week05Day02["Day Module: Day_02"]:::dayModules
                    Week05Day03["Day Module: Day_03"]:::dayModules
                    Week05Day04["Day Module: Day_04"]:::dayModules
                    Week05Day05["Day Module: Day_05"]:::dayModules
                end
                Week05Title --> Week05Day01
                Week05Title --> Week05Day02
                Week05Title --> Week05Day03
                Week05Title --> Week05Day04
                Week05Title --> Week05Day05
            end

            %% Week 06 Module
            subgraph "Week 06 Module"
                Week06Folder["Folder: Week_06/"]:::weekModules
                Week06Title["week_title.txt"]:::weekModules
                Week06Pres["week_presentation.txt"]:::weekModules
                Week06Folder --> Week06Title
                Week06Folder --> Week06Pres
                subgraph "Day Modules"
                    Week06Day01["Day Module: Day_01"]:::dayModules
                    Week06Day02["Day Module: Day_02"]:::dayModules
                    Week06Day03["Day Module: Day_03"]:::dayModules
                    Week06Day04["Day Module: Day_04"]:::dayModules
                    Week06Day05["Day Module: Day_05"]:::dayModules
                end
                Week06Title --> Week06Day01
                Week06Title --> Week06Day02
                Week06Title --> Week06Day03
                Week06Title --> Week06Day04
                Week06Title --> Week06Day05
            end
        end
    end

    %% Relationships between global components and weekly modules
    README -->|"guides"| ASSET
    ASSET -->|"template"| Week01Folder
    ASSET -->|"template"| Week02Folder
    ASSET -->|"template"| Week03Folder
    ASSET -->|"template"| Week04Folder
    ASSET -->|"template"| Week05Folder
    ASSET -->|"template"| Week06Folder

    %% Click Events
    click README "https://github.com/thehackingproject/devops-introduction/blob/master/README.md"
    click SCRIPT "https://github.com/thehackingproject/devops-introduction/blob/master/first_script.sh"
    click ASSET "https://github.com/thehackingproject/devops-introduction/tree/master/assets/"
    click LessonExample "https://github.com/thehackingproject/devops-introduction/blob/master/assets/lesson_example.md"
    click ProjectExample "https://github.com/thehackingproject/devops-introduction/blob/master/assets/project_example.md"
    click Week01Folder "https://github.com/thehackingproject/devops-introduction/tree/master/week_01/"
    click Week01Title "https://github.com/thehackingproject/devops-introduction/blob/master/week_01/week_title.txt"
    click Week01Pres "https://github.com/thehackingproject/devops-introduction/blob/master/week_01/week_presentation.txt"
    click Week02Folder "https://github.com/thehackingproject/devops-introduction/tree/master/week_02/"
    click Week02Title "https://github.com/thehackingproject/devops-introduction/blob/master/week_02/week_title.txt"
    click Week02Pres "https://github.com/thehackingproject/devops-introduction/blob/master/week_02/week_presentation.txt"
    click Week03Folder "https://github.com/thehackingproject/devops-introduction/tree/master/week_03/"
    click Week03Title "https://github.com/thehackingproject/devops-introduction/blob/master/week_03/week_title.txt"
    click Week03Pres "https://github.com/thehackingproject/devops-introduction/blob/master/week_03/week_presentation.txt"
    click Week04Folder "https://github.com/thehackingproject/devops-introduction/tree/master/week_04/"
    click Week04Title "https://github.com/thehackingproject/devops-introduction/blob/master/week_04/week_title.txt"
    click Week04Pres "https://github.com/thehackingproject/devops-introduction/blob/master/week_04/week_presentation.txt"
    click Week05Folder "https://github.com/thehackingproject/devops-introduction/tree/master/week_05/"
    click Week05Title "https://github.com/thehackingproject/devops-introduction/blob/master/week_05/week_title.txt"
    click Week05Pres "https://github.com/thehackingproject/devops-introduction/blob/master/week_05/week_presentation.txt"
    click Week06Folder "https://github.com/thehackingproject/devops-introduction/tree/master/week_06/"
    click Week06Title "https://github.com/thehackingproject/devops-introduction/blob/master/week_06/week_title.txt"
    click Week06Pres "https://github.com/thehackingproject/devops-introduction/blob/master/week_06/week_presentation.txt"

    %% Styles
    classDef globalDocs fill:#f8e71c,stroke:#000,stroke-width:2px;
    classDef assets fill:#7ED321,stroke:#000,stroke-width:2px;
    classDef weekModules fill:#50E3C2,stroke:#000,stroke-width:2px;
    classDef dayModules fill:#D0021B,stroke:#000,stroke-width:2px;
```
