Project

General

Profile

Actions

Documentation #5531

open

userguide: ensure documentation is up to date

Added by Juliana Fajardini Reichow 3 months ago. Updated 3 months ago.

Status:
New
Priority:
Normal
Target version:
Affected Versions:
Effort:
Difficulty:
Label:

Description

Currently, it is sometimes possible to find in our documentation mentions of Suricata versions that have reached end of life.

We would like to make sure that what is in the documentation is current and still valid.

Ideally, we want to have some smart tooling that supports automated checks for this, too.

There are two aspects to consider:
- coherence in terms of versions (i.e., is the documentation version current in relation to the associated Suricata version?)
- synchronization between code, built-in defaults, yaml configuration defaults, and what's in the documentation

--
One possible approach to get started with could be to dump all configurations for Suri (src/suricata --dump-config), then use a git grep in the documentation and see if those are in synch.

Actions #1

Updated by Juliana Fajardini Reichow 3 months ago

  • Description updated (diff)
Actions #2

Updated by Juliana Fajardini Reichow 3 months ago

  • Assignee changed from OISF Dev to Juliana Fajardini Reichow
Actions #3

Updated by Juliana Fajardini Reichow 3 months ago

Wondering if we could change the approach to this by making as much of the documentation version agnostic as possible. Would that make sense for us?

The idea then would be that only what did change would be version tagged. Dunno if that's easily achievable, though...

Actions

Also available in: Atom PDF