How owasp/cheatsheetseries works
OWASP Cheat Sheet Series is a curated security-knowledge repository. Contributors create or revise Markdown guidance, examples, and supporting diagrams; indexes organize the published material; site tooling produces the official web and offline experiences; builders read the resulting cheat sheets. The sampled scripts also show an RSS-generation path backed by GitHub pull-request data. Some publishing internals are inferred only from README-described commands, while the content and index-generation relationships are directly evidenced.
Main entry points: Generate_Site.sh Site Generator · cheatsheets Published Cheat Sheets · Update_CheatSheets_Index.py Index Generator · Generate_RSS_Feed.py RSS Generator
Components 18
Content Authoring
- Published Cheat Sheets
cheatsheets - Draft Cheat Sheets
cheatsheets_draft - Security Assets
assets - Contribution Guidance
GUIDELINE.md
Knowledge Organization
- Alphabetical Index
Index.md - ASVS Index
IndexASVS.md - MASVS Index
IndexMASVS.md - Proactive Controls Index
IndexProactiveControls.md - Index Generator
scripts/Update_CheatSheets_Index.py - TOC Generator
scripts/Generate_CheatSheets_TOC.py
Publication Delivery
- Site Generator
scripts/Generate_Site.sh - Official Website
- Offline Website Bundle
Project Operations
- RSS Generator
scripts/Generate_RSS_Feed.py - News Feed
Other components
- Contributors
- Application Builders
- GitHub API
Connections 17
- Contributors → Contribution Guidance: reads
- Contributors → Draft Cheat Sheets: proposes
- Contributors → Published Cheat Sheets: edits
- Contributors → Security Assets: contributes
- Index Generator → Published Cheat Sheets: scans
- Index Generator → Alphabetical Index: writes
- TOC Generator → Published Cheat Sheets: scans
- Site Generator → Published Cheat Sheets: builds from
- Site Generator → Alphabetical Index: reads
- Site Generator → ASVS Index: reads
- Site Generator → MASVS Index: reads
- Site Generator → Proactive Controls Index: reads
- Site Generator → Official Website: publishes
- Site Generator → Offline Website Bundle: packages
- Application Builders → Official Website: reads
- RSS Generator → GitHub API: fetches PRs
- RSS Generator → News Feed: writes feed