Project

General

Profile

Actions

Documentation #5531

closed

userguide: ensure documentation is up to date

Added by Juliana Fajardini Reichow almost 3 years ago. Updated 8 days ago.

Status:
Rejected
Priority:
Normal
Assignee:
-
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 sync.

Actions #1

Updated by Juliana Fajardini Reichow almost 3 years ago

  • Description updated (diff)
Actions #2

Updated by Juliana Fajardini Reichow almost 3 years ago

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

Updated by Juliana Fajardini Reichow almost 3 years 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 #4

Updated by Juliana Fajardini Reichow over 2 years ago

  • Target version changed from TBD to 8.0.0-beta1
Actions #5

Updated by Victor Julien over 1 year ago

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

Updated by Victor Julien 6 months ago

  • Target version changed from 8.0.0-beta1 to 8.0.0-rc1
Actions #7

Updated by Victor Julien about 1 month ago

  • Target version changed from 8.0.0-rc1 to 8.0.0
Actions #8

Updated by Juliana Fajardini Reichow about 1 month ago

  • Description updated (diff)
Actions #9

Updated by Juliana Fajardini Reichow 25 days ago

  • Status changed from New to Rejected

Thinking again about this, a ticket for this doesn't work very well, and maybe not many people care about this.

Actions #10

Updated by Shivani Bhardwaj 8 days ago

  • Assignee deleted (OISF Dev)
  • Target version deleted (8.0.0)
Actions

Also available in: Atom PDF