How notharshhaa/into-the-devops works
Project Type & Purpose
• This is a documentation-centric learning repository (no monolithic application or multi-service backend).
• Purpose: host Markdown-based tutorials, exercises, and solutions on DevOps & Cloud topics, plus a small CI check.
File Structure
• Top-Level Artifacts:
• README.md (landing page)
• topics/ (all domain-specific content: AWS, GCP, Kubernetes, etc.)
• tests/ (syntax_lint.py → verifies Markdown syntax)
• run_ci.sh (invoked by CI/CD)
• prepare_for_interview.md (bonus content)
• CONTRIBUTING.md / CODE_OF_CONDUCT.md
• Patterns:
• Modular topic directories under topics/
• Exercise vs. Solution sub-dirs
• A lightweight CI step (shell + Python lint)
README for Insights
• Confirms static, content-focused site.
• No server or frontend framework; likely served as GitHub Pages or similar.
• CI role: syntax checks before merge.
Main Components & Their Relationships
a. Repository (authoritative Markdown source)
b. CI Pipeline (run_ci.sh + tests/syntax_lint.py)
c. Content Modules (topics/*)
d. Static Site Publisher (e.g., GitHub Pages or similar)
e. Consumers (learners browsing docs)
Data-flow:
• Developer pushes Markdown → CI pipeline triggered → syntax checks → if green, merge → content published → end users consume.
Architectural Patterns / Design Principles
• Content Modularity: each topic is a self-contained module (exercise vs. solution).
• Single Source of Truth: all tutorials live in Git.
• Automated Validation: minimal CI ensures consistency.
• Publish-On-Merge: echoes a GitOps approach (push triggers publish).
Relevant Technologies
• Markdown
• shell scripting (Bash)
• Python (lint script)
• Git (version control)
• GitHub Pages or similar static-site hosting (implied)
Essential Elements
• Clear Labels: “Git Repo,” “CI (run_ci.sh + lint),” “Static Site Host,” “Learner”