How microsoft/security-101 works
Main Components
• Source Code Repository: Represent the GitHub repository as the central hub where all content, configurations, and workflows reside.
• Static Website (Frontend): Include the index.html and images directories as the presentation layer that renders the course content to learners.
• Build & Deployment Infrastructure: Highlight the .github/workflows directory containing ‘deploy.yaml’ and ‘jekyll-gh-pages.yml’ files, which indicate automated deployment using GitHub Actions and possibly Jekyll for transforming Markdown to HTML.
• Project Management & Support: Include components for documentation and best practices such as README.md, CODE_OF_CONDUCT.md, SECURITY.md, and SUPPORT.md.
• External Integrations: If applicable, denote dependencies on GitHub Pages (or another hosting service) driven by the workflows, and potentially integration with Microsoft Learn as referenced in the README.
Relationships and Interactions
• Deployment: Show how changes pushed to the repository trigger workflows that automatically deploy the updated static site to GitHub Pages or another hosting service.
• Version Control & Collaboration: Illustrate how GitHub’s issue templates, pull requests, and community contributions (indicated by provided issue/feature templates) connect to the management of course content and updates.
Architectural Patterns & Design Principles
• Content-Driven Static Architecture: Emphasize that the project is designed for delivering content. The separation between content (Markdown/quiz files) and presentation (HTML/CSS assets) is crucial.
• CI/CD Automation: Highlight the continuous integration and deployment process via GitHub Actions workflows. This encapsulates modern DevOps practices.
• Modular Organization: Note the design principle of modularity. Each module is self-contained and could potentially be updated independently, reflecting a loosely coupled design.
Technologies, Frameworks, and Libraries
• GitHub & Git: For version control and collaboration.
• Markdown: For content creation.
• Jekyll (implied by jekyll-gh-pages.yml): For static site generation.
• GitHub Actions: For CI/CD (automated build and deployment).
• HTML/CSS (and possibly JavaScript) for the frontend presentation.
Additional Elements
• Location of quizzes (e.g., End of module quiz files) as integral parts of the learning feedback mechanism.
• If space allows, illustrate external links (e.g., video introduction, further Microsoft learning resources) to indicate how the curriculum extends beyond the repository.