How keenanromain/aws-saa-c02-study-guide works
Project type and purpose
• This is a static documentation project: one README.md that serves as an AWS Solutions Architect Study Guide.
• Purpose: authors maintain content in Markdown; readers consume it via a web‐served static site or GitHub render.
File structure
• Only file: README.md at root. No code, no subdirectories—pure Markdown content.
• Implies a static‐site workflow: version control → build (optional) → hosting → CDN → clients.
README for insights
• Deeply structured, with headings, links, images—ideal for a static site generator or direct GitHub Pages publication.
• Content is broken into logical sections (IAM, S3, EC2, etc.)—these become navigation nodes in the site.
a. Content Source
– Author workstation (editor)
– README.md in a Git repository (e.g. GitHub)
b. Build pipeline (optional)
– Static‐site generator (Jekyll, Docsify, MkDocs, Hugo, etc.)
– CI/CD (GitHub Actions, GitLab CI, etc.)
c. Hosting & delivery
– GitHub Pages or S3 bucket + CloudFront CDN
– DNS (custom domain, Route 53 or other)
d. Consumers
– Web browsers or mobile devices fetching assets via HTTPS
Relationships & data flows
• Author “push” → Git repo triggers CI build → SSG transforms README.md into HTML/CSS/JS
• CI artifacts deployed to hosting (GitHub Pages or S3)
• CDN caches assets at edge locations
• User browser requests page → CDN → origin fail‐over if needed
• User feedback (Issues/PRs) loops back to Git repo
Architectural patterns & design principles
– Separation of concerns: content vs. build vs. hosting
– Infrastructure as code: represent CDN, DNS, bucket as configuration steps
– “Immutable” site artifacts for easy rollback
– Use of managed services (GitHub, S3, CloudFront) to minimize ops
Technologies/frameworks/libraries
– Markdown (README.md)
– Git/GitHub (version control)
– Static‐site generator (e.g. Jekyll, MkDocs)
– CI/CD pipeline (e.g. GitHub Actions)
– Hosting: GitHub Pages or AWS S3 + CloudFront
– DNS: Route 53 (optional)