How damian-sztankowski/the-etherlight-legacy-google-cloud-adventures works
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