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

docs: updates for consistencies - v1 #11807

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

Conversation

jufajardini
Copy link
Contributor

Update docs to:

  • replace, where appropriate, Suricata 6 references with Suricata 7 ones
  • use sed mentioned above shared by Shivani and a variation to find and replace mentions to our suricata.yaml that were still using dashes instead of underscores
  • also update yaml partials that is referred to in the configuration/suricata-yaml section

Link to ticket: https://redmine.openinfosecfoundation.org/issues/
https://redmine.openinfosecfoundation.org/issues/7260
https://redmine.openinfosecfoundation.org/issues/7262

TODO?

Must further investigate to understand if anything here must be updated:

Use sed + regex to replace all occurrences of suricata.yaml terms that
used underscore for their up-to-date dash version.

Also search for such terms in the eve-log.yaml partials file, as that
is referenced in the configuration section.

commands used:

sed -i 's/\(^ *[a-z]*\)_\([a-z]*:\)/\1-\2/g'
sed -i 's/\(^ *[a-z]*\)_\([a-z]*\)_\([a-z]*:\)/\1-\2-\3/g'

Some other instances were found manually.

Task OISF#7260
@jufajardini jufajardini changed the title doc/conf/yaml: replace underscore with dashes - v1 docs: updates for consistencies - v1 Sep 20, 2024
@jufajardini jufajardini added the typo/doc update No code change : only doc or typo fixes label Sep 20, 2024
Copy link

codecov bot commented Sep 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.59%. Comparing base (2b1ad81) to head (e49c4b1).

Additional details and impacted files
@@            Coverage Diff             @@
##           master   #11807      +/-   ##
==========================================
- Coverage   82.59%   82.59%   -0.01%     
==========================================
  Files         919      919              
  Lines      249091   249091              
==========================================
- Hits       205738   205735       -3     
- Misses      43353    43356       +3     
Flag Coverage Δ
fuzzcorpus 60.49% <ø> (ø)
livemode 18.69% <ø> (-0.01%) ⬇️
pcap 44.12% <ø> (+0.63%) ⬆️
suricata-verify 61.90% <ø> (-0.05%) ⬇️
unittests 59.00% <ø> (ø)

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

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.

1 participant