Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

userguide: explain rule types and categorization - v8 #12184

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

jufajardini
Copy link
Contributor

@jufajardini jufajardini commented Nov 29, 2024

Previous PR: #12114

Link to ticket: https://redmine.openinfosecfoundation.org/issues/
https://redmine.openinfosecfoundation.org/issues/7031

Please check the built version: https://suri-rtd-test.readthedocs.io/en/doc-sigtypes-et-properties-v8/rules/rule-types.html

Describe changes:

Many of the examples and conclusions documented here were derived from tests and checks as seen on OISF/suricata-verify#2153

This enables the usage of collapsible sections for the docs.
Add documentation about the rule types introduced by 2696fda.

Add doc tags around code definitions that are referenced in the docs.

Task #https://redmine.openinfosecfoundation.org/issues/7031
@jufajardini jufajardini added the typo/doc update No code change : only doc or typo fixes label Nov 29, 2024
@jufajardini jufajardini marked this pull request as draft November 29, 2024 21:56
@jufajardini
Copy link
Contributor Author

Moved to draft as I see too many CI failures.
Still apt for a review, though, please.

Copy link

codecov bot commented Nov 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 49.98%. Comparing base (287d836) to head (e94d4f1).

Additional details and impacted files
@@           Coverage Diff           @@
##           master   #12184   +/-   ##
=======================================
  Coverage   49.98%   49.98%           
=======================================
  Files         912      912           
  Lines      257066   257066           
=======================================
+ Hits       128503   128505    +2     
+ Misses     128563   128561    -2     
Flag Coverage Δ
fuzzcorpus 60.98% <ø> (-0.01%) ⬇️
livemode 19.41% <ø> (-0.01%) ⬇️
pcap 44.47% <ø> (+0.06%) ⬆️
suricata-verify 62.71% <ø> (-0.01%) ⬇️
unittests 9.01% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@suricata-qa
Copy link

WARNING:

field baseline test %
build_asan

Pipeline 23611

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
typo/doc update No code change : only doc or typo fixes
Development

Successfully merging this pull request may close these issues.

2 participants