Proposal for New Documentation Site for IntelOwl and friends
- Mentors
- Matteo Lodi, Daniele Rosetti
- Organization
- The Honeynet Project
- Technologies
- python, django, markdown, GitHub Actions, mkdocs, GitHub Pages, Swagger UI
- Topics
- security, web development, documentation, ui, infrastructure
This project aims to enhance the documentation infrastructure of IntelOwl by migrating from ReadTheDocs to Mkdocs and leveraging GitHub Pages for automatic deployment. The current documentation lacks reusability and ease of use for contributors, making it challenging for them to navigate and contribute effectively. By migrating to Mkdocs and integrating Swagger UI for API documentation, we aim to improve accessibility and user experience. The project timeline includes setting up Mkdocs, migrating existing documentation, writing docstrings for automatic documentation generation, and implementing automatic deployment using GitHub Actions. Upon completion, users will benefit from a well-organized and easily navigable documentation platform, fostering community engagement and project sustainability.