How piyushsachdeva/devops-roadmap works
Project type and purpose
• This is an open-source “learning path” documentation repository (no runtime code, no backend API)—essentially a static content site describing a DevOps & Cloud Engineering curriculum.
• Its purpose is to deliver a structured roadmap, reference links, and community pointers to learners.
File structure
• Top level contains only README.md (with embedded roadmap_v1.gif). No “src” or “app” code.
• Implies a static-site generator (SSG) or simple GitHub-Pages setup could render HTML from Markdown.
• Absence of CI/CD config files suggests you may introduce a simple build pipeline (e.g., GitHub Actions) to publish to GitHub Pages or another host.
README for additional insights
• The README is the core content, broken into phases, external links (YouTube, Discord, etc.), and a roadmap image.
• No internal services—mostly links out to third-party tools (YouTube, Discord, Twitter, etc.).
• Audience: learners; Contributors: open-source community.
a. Main components:
• Content Repository (GitHub)
• CI/CD Pipeline (e.g., GitHub Actions)
• Static Site Generator (e.g., Jekyll, Hugo, MkDocs)
• Hosting Layer (GitHub Pages, Netlify, or similar)
• CDN (optional)
• User Browser (Learner)
• External services (YouTube, Discord, Twitter, LinkedIn)
b. Relationships & interactions:
• Contributor pushes Markdown to GitHub → triggers CI/CD build.
• CI/CD runs SSG → outputs HTML/CSS/JS artifacts.
• Artifacts deployed to Hosting → optionally fronted by CDN.
• Learner’s browser requests pages from CDN/host → renders content.
• Learner follows external links → YouTube, Discord, etc.
c. Architectural patterns/design principles:
• “Docs as code” – treat docs like software, version-controlled and built by CI.
• Static website pattern – no server-side code at runtime; high performance and low attack surface.
• Modular content – each README section, image, and link is a separate asset.
d. Technologies/frameworks/libraries:
• GitHub for source control
• GitHub Actions (or other CI) for build & deploy
• Static site generator of choice (Jekyll/Hugo/MkDocs)
• Hosting: GitHub Pages or Netlify
• CDN: Cloudflare or Netlify CDN