Actions
Task #3343
opentracking: developer documentation
Effort:
Difficulty:
Label:
Description
Goal is to create a developer guide similar to the user guide. So it will also live in the git repo and will using sphinx for the higher level guides.
For low level, we will continue to use doxygen.
In addition, for the Rust and Python components we need to support other low level frameworks as well like rustdoc.
Provisional TOC (will update as needed)
TOC working with the codebase - contributing = process (github) = quality requirements - style - debugging - performance = concepts = analysis and tooling internals - packet pipeline - threading - common data structures extending - capture methods - packet decoders - app-layer protocols - detection - outputs
Existing documentation can be found here https://redmine.openinfosecfoundation.org/projects/suricata/wiki/Suricata_Developers_Guide. Much of this is outdated, so we shouldn't just copy it over. But it may be a good starting point for some of the new docs.
Updated by Victor Julien over 4 years ago
Basic structure with above TOC has been set up https://github.com/OISF/suricata/pull/4904
Updated by Victor Julien about 4 years ago
- Target version changed from 6.0.0beta1 to 6.0.0rc1
Updated by Victor Julien about 4 years ago
- Target version changed from 6.0.0rc1 to 7.0.0-beta1
Updated by Victor Julien over 2 years ago
- Subject changed from Tracking: developer documentation to tracking: developer documentation
Updated by Victor Julien almost 2 years ago
- Target version changed from 7.0.0-beta1 to 7.0.0-rc1
Updated by Victor Julien almost 2 years ago
- Target version changed from 7.0.0-rc1 to 8.0.0-beta1
Updated by Victor Julien 2 months ago
- Related to Documentation #7150: devguide: document adding a logging plugin added
Actions