How adriasir123/pi-fortinet works
Project type and purpose
• This is a static documentation website built with MkDocs (a Python-based static site generator).
• Its purpose is to host and present a “Memoria de Proyecto Integrado” on Fortinet cybersecurity—rich markdown content, images, code snippets, and CLI demos—all packaged as a web site.
File structure
• Top-level:
• .github/workflows/ci.yml → GitHub Actions CI/CD pipeline
• mkdocs.yml → MkDocs configuration (site name, theme, pages order, plugins)
• docs/ → Source markdown files, organized into subfolders (conceptos, demo, interfaz-web, etc.), plus assets (images, javascripts, stylesheets)
• README.md, LICENSE, .gitignore
• Patterns:
• “docs” is the content root for MkDocs
• Static assets separated into images/, javascripts/, stylesheets/
• CI pipeline builds and deploys to GitHub Pages
Key README insights
• It’s a web site (“Accede aquí: https://pi.adrianj.eu/”)
• No custom backend—purely static content
• Deployment target: GitHub Pages
Detailed breakdown of components
• Developer Workstation
• Tools: Markdown editor, Git CLI
• GitHub Repository
• Branches: main (source), gh-pages (deploy)
• CI config: .github/workflows/ci.yml
• CI/CD (GitHub Actions)
• Steps: checkout → setup Python → install MkDocs → mkdocs build → deploy to gh-pages
• MkDocs Configuration (mkdocs.yml)
• Site name, nav structure, plugins, theme settings
• Static Assets
• docs/images → images served alongside HTML
• docs/javascripts, docs/stylesheets → custom scripts & CSS
• Hosting Layer
• GitHub Pages serves / (root) over HTTPS
• DNS A/CNAME record pointing to GitHub Pages
• End User
• Browser fetches HTML/CSS/JS
• Content delivered via GitHub’s global CDN