# damian-sztankowski/the-etherlight-legacy-google-cloud-adventures architecture

> Architecture diagram of the GitHub repository damian-sztankowski/the-etherlight-legacy-google-cloud-adventures, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/damian-sztankowski/the-etherlight-legacy-google-cloud-adventures
- Repository: https://github.com/damian-sztankowski/the-etherlight-legacy-google-cloud-adventures

## Overview

##### Project Type and Purpose
- This is a static content publishing project: an interactive, fantasy-themed eBook titled “The Etherlight Legacy” that teaches Google Cloud concepts through narrative.
- It’s not a running service or microservice mesh—it’s a content pipeline that transforms Markdown source (chapters and glossary) plus visuals into distributable artifacts (PDF/EPUB), hosted in a Git repository and released via GitHub.

##### File-Structure Analysis
- Top-Level Directories:
- book/       → Markdown chapters (`chapter-1.md` …)
- glossary/   → Per-chapter fantasy-to-tech mappings (`chapter-1-glossary.md` …)
- visuals/    → Illustrations organized by chapter
- Root Files:
- README.md   → Project overview, usage, contributing guide
- LICENSE     → CC BY-NC-SA 4.0
- .gitignore  → Standard VCS exclusions
- Build Artifacts (in dist/ via releases, not in tree):
- PDF and in-progress EPUB distributions

##### README Insights
- Describes the narrative approach, learning goals, and repository structure.
- Mentions download links (PDF/EPUB), the glossary, and visual style.
- No custom build scripts are in the tree, but implies use of a static-site generator or Pandoc to produce outputs.

a. Main Components
1. Source Content Layer
– book/ Markdown chapter files
– glossary/ Markdown glossary files
– visuals/ images and illustrations
2. Build Pipeline
– Conversion tool (e.g., Pandoc, mdBook, custom scripts)
– Configuration files (hypothetical build config)
3. Version Control & CI/CD
– GitHub repository (branches, pull requests)
– CI runner triggering builds on commit/tag
4. Output Artifacts
– Generators produce PDF, EPUB (in dist/)
5. Distribution & Consumption
– GitHub Releases for PDF and EPUB
– End-user reading platforms (PDF reader, eBook reader)

b. Relationships & Data Flow
– Feedback loop from Consumers (issues, PRs) back into Source Content via GitHub

c. Architectural Patterns & Principles
– Separation of concerns: content-authoring, rendering, and distribution are distinct modules
– Immutable artifacts: every tagged release produces a freeze of PDF/EPUB
– Traceable revision history: all content under version control
– Extensibility: adding new chapters, formats, or visuals does not change core pipeline

d. Key Technologies & Libraries
– Markdown (book & glossary)
– Illustrations (hand-drawn or AI-generated assets in visuals/)
– Static generator (Pandoc or mdBook) or custom Node/Python script
– GitHub (source hosting, CI, Releases)
– PDF and EPUB as output formats

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Source Content Layer
    subgraph "Source Content Layer"
        direction TB
        Book["book/"]:::source
        Glossary["glossary/"]:::source
        Visuals["visuals/"]:::source
    end

    %% Version Control & CI/CD
    subgraph "Version Control & CI/CD"
        direction TB
        Repo["GitHub Repo"]:::external
        Gitignore[".gitignore"]:::external
        Readme["README.md"]:::external
        License["LICENSE"]:::external
        CI["CI Runner"]:::external
    end

    %% Build Pipeline
    subgraph "Build Pipeline"
        direction TB
        Converter["Conversion Tool (Pandoc/mdBook)"]:::build
        Config["Build Config"]:::build
    end

    %% Output Artifacts
    subgraph "Output Artifacts"
        direction TB
        PDF["PDF (dist/)"]:::artifact
        EPUB["EPUB (dist/)"]:::artifact
    end

    %% Distribution & Consumption
    subgraph "Distribution & Consumption"
        direction TB
        Releases["GitHub Releases"]:::external
        EndUser["End-user Readers"]:::external
    end

    %% Data Flow
    Book -->|source files| Converter
    Glossary -->|glossary files| Converter
    Visuals -->|images| Converter
    Config -->|config| Converter
    Repo -->|on push/tag| CI
    CI -->|triggers build| Converter
    Converter -->|generates| PDF
    Converter -->|generates| EPUB
    PDF -->|uploaded to| Releases
    EPUB -->|uploaded to| Releases
    Releases -->|downloads| EndUser
    EndUser -.->|issues/PRs| Repo

    %% Click Events
    click Book "https://github.com/damian-sztankowski/the-etherlight-legacy-google-cloud-adventures/tree/main/book/"
    click Glossary "https://github.com/damian-sztankowski/the-etherlight-legacy-google-cloud-adventures/tree/main/glossary/"
    click Visuals "https://github.com/damian-sztankowski/the-etherlight-legacy-google-cloud-adventures/tree/main/visuals/"
    click Gitignore "https://github.com/damian-sztankowski/the-etherlight-legacy-google-cloud-adventures/blob/main/.gitignore"
    click Readme "https://github.com/damian-sztankowski/the-etherlight-legacy-google-cloud-adventures/blob/main/README.md"
    click License "https://github.com/damian-sztankowski/the-etherlight-legacy-google-cloud-adventures/tree/main/LICENSE"
    click PDF "https://github.com/damian-sztankowski/the-etherlight-legacy-google-cloud-adventures/blob/main/book/Chapter1.pdf"

    %% Styles
    classDef source fill:#B3D4FC,stroke:#0366d6,color:#000
    classDef build fill:#C8E6C9,stroke:#2e7d32,color:#000
    classDef artifact fill:#FFE0B2,stroke:#ef6c00,color:#000
    classDef external fill:#E1BEE7,stroke:#6a1b9a,color:#000
```
