Skip to content

GSOC 2024 PROJECT

Proposal for New Documentation Site for IntelOwl and friends

Contributor
Aryan Bhokare
Mentors
Matteo Lodi, Daniele Rosetti
Organization
The Honeynet ProjectSecurity
Program
GSoC 2024Completed

About this project

Description from the program archive

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.

Tags

From the people who did it

No proposal or progress posts shared yet

Worked on this project? Share the proposal that got you selected and the posts you wrote.

Claim this project
  1. New Analyzers for IntelOwl

    NilayGuptaMentored by Matteo Lodi, Daniele Rosetti

  2. ML-based web attack classification project for TANNER

    Hinna ZeejahMentored by Evgeniia Tokarchuk

  3. Extending The Artemis Scanner

    Kshitij KapoorMentored by Krzysztof Zając

  4. Improving the Functionality of Honeyscanner: A Honeypot Vulnerability Analyzer.

    SeanB.Mentored by Shreyas Srinivasa, Manolis, Aristofanis Chionis

  5. Improving the functionality of Honeyscanner: a honeypot vulnerability analyzer

    DarMentored by Shreyas Srinivasa, Manolis, Aristofanis Chionis

  6. Extending the DRAKVUF Sandbox analytic pipeline

    Yacine ElhamerMentored by Jarosław Jedynak

  7. Improve features for DNS and HTTP3 in mitmproxy

    Gaurav J.Mentored by Maximilian Hils, Emanuele Micheletti

  8. Improve the onboarding experience on mitmweb

    Matteo LuppiMentored by Maximilian Hils, Emanuele Micheletti

Data: Google Summer of Code public archive. This project in the official archive