suricata
suricata copied to clipboard
userguide: add eve schema generate doc - v3
Previous PR: https://github.com/OISF/suricata/pull/8971
Just a new PR for cleaner history, contains requested changes from https://github.com/OISF/suricata/pull/8933.
Also contains updated QUIC doc from https://github.com/OISF/suricata/pull/9097.
Generated documentation:
- QUIC: https://jasonish-suricata.readthedocs.io/en/evedoc-v3/output/eve/eve-json-format.html?highlight=quic#event-type-quic
- PGSQL: https://jasonish-suricata.readthedocs.io/en/evedoc-v3/output/eve/eve-json-format.html?highlight=pgsql#field-reference- Complete: https://jasonish-suricata.readthedocs.io/en/evedoc-v3/appendix/eve-index.html
Redmine issue: https://redmine.openinfosecfoundation.org/issues/6288
Codecov Report
Merging #9165 (263aa37) into master (9b09b29) will decrease coverage by
0.01%
. The diff coverage isn/a
.
:exclamation: Current head 263aa37 differs from pull request most recent head 6a2fab7. Consider uploading reports for the commit 6a2fab7 to get more accurate results
Additional details and impacted files
@@ Coverage Diff @@
## master #9165 +/- ##
==========================================
- Coverage 82.34% 82.33% -0.01%
==========================================
Files 968 968
Lines 273546 273546
==========================================
- Hits 225247 225233 -14
- Misses 48299 48313 +14
Flag | Coverage Δ | |
---|---|---|
fuzzcorpus | 64.58% <ø> (-0.02%) |
:arrow_down: |
suricata-verify | 60.73% <ø> (-0.02%) |
:arrow_down: |
unittests | 62.90% <ø> (+<0.01%) |
:arrow_up: |
Flags with carried forward coverage won't be shown. Click here to find out more.
Converting to draft. This has a similar issue to the generated diagrams. If we generate the rst
documentation in conf.py
, make distcheck
will fail, as when the documentation is generated, Suricata is being built in a read-only directory.
If we generate with the Makefile
, distcheck
will be satisfied, but Readthedocs will fail.
Options include:
- Generate from both
conf.py
andMakefile
- Manually generate and check-in (like the diagrams)
Is there a redmine ticket for this ?
Is there a redmine ticket for this ?
Do now: https://redmine.openinfosecfoundation.org/issues/6288
Closing as stale and needing rebase