How linkedin/school-of-sre works
Project Type and Purpose
• The project is an educational website that hosts various courses related to topics like Linux, Git, databases, containerization, system design, and more.
• It leverages content written in Markdown (organized into courses and levels) and uses MkDocs for static site generation. Customization is done via “overrides” (custom HTML partials) and styling (custom CSS in courses/stylesheets).
• Additionally, GitHub workflows (in .github/workflows) and other CI/CD files indicate an automated deployment process.
Main Components
a. Content Repository (Courses):
• The courses directory holds all the educational materials, organized by levels (level101, level102) and topics (e.g., python_web, linux_basics, system_design).
• It includes subdirectories for images, Markdown files, and supplementary materials (like CODE_OF_CONDUCT, CONTRIBUTING guidelines).
b. Documentation/Static Site Generator:
• The mkdocs.yml file indicates that MkDocs is used as the static site generator.
• The Overrides directory (with custom HTML partials) is used for modifying theme elements (e.g., header, nav).
• requirements.txt and any related configuration files show dependencies that MkDocs and possibly other Python packages use to build the site.
c. Deployment & CI/CD:
• The .github/workflows folder includes deployment workflows (e.g., gh-deploy.yml), automating the build and publishing process, likely to GitHub Pages or a similar hosting service.
• This part of the design automates testing and deployment for updating the educational content live.
d. Community and Documentation Support:
• Files like LICENSE, NOTICE, CONTRIBUTING.md, and courses/sre_community.md indicate community and governance aspects that could be represented alongside the main components.
Relationships and Data/Control Flow
• The Markdown content in the “courses” directory is processed by MkDocs (using the configuration defined in mkdocs.yml) to generate static webpages.
• Custom overrides (from the “overrides” folder) and custom stylesheets (from courses/stylesheets) are applied during the build process.
• The build and deployment processes are managed using GitHub workflows which listen for changes in the repository, triggering CI/CD pipelines.
• The produced static site is then published (potentially to GitHub Pages or another hosting platform).
Architectural Patterns and Design Principles
• Separation of Concerns: Content is maintained separately (organized in course directories) and presentation is handled by the static site generator.
• Modular Design: Each course or topic is a self-contained module (level101, level102, etc.), making it easy to extend and manage.
• Automation: CI/CD pipelines (GitHub Actions) are used to ensure the latest content and configuration changes are deployed automatically.