Project

General

Profile

Actions

Task #8118

open
JF OD

docs: use dynamic suricata version mentions

Task #8118: docs: use dynamic suricata version mentions

Added by Juliana Fajardini Reichow 9 months ago. Updated 16 days ago.

Status:
Triaged
Priority:
Normal
Assignee:
Target version:
Effort:
Difficulty:
Label:

Description

To avoid what we have with #8113, have the suricata versions mentioned in the docs be variables.

Decided whether via something like a variable ( %VERSION% ) or via Sphinx build-time method, or something else.


Subtasks 1 (1 open0 closed)

Task #8772: docs: use dynamic suricata version mentions (8.0.x backport)TriagedOISF DevActions

Related issues 1 (0 open1 closed)

Related to Suricata - Documentation #8113: doc: remove mention of suricata-7 in latest docsClosedJuliana Fajardini ReichowActions

JF Updated by Juliana Fajardini Reichow 9 months ago Actions #1

JF Updated by Juliana Fajardini Reichow 8 months ago Actions #2

will require more exploration. There are Sphinx directives that could work to check which version we're building, such as ifconfig (https://www.sphinx-doc.org/en/master/usage/extensions/ifconfig.html#directive-ifconfig) but the version to be replaced happens to be within a code-block, so we'd need an external extension for that, from what I could see (Found https://pypi.org/project/sphinx-substitution-extensions/, not sure yet if that would work on RtD).

JF Updated by Juliana Fajardini Reichow 8 months ago Actions #3

Tried using this substitutions extension, but didn't manage to make it work, locally:

 WARNING: Pygments lexer name ':substitutions:' is not known [misc.highlighting_failure]

Will keep trying.

PA Updated by Philippe Antoine 16 days ago Actions #4

  • Status changed from New to Triaged
  • Assignee set to OISF Dev

PA Updated by Philippe Antoine 16 days ago Actions #5

  • Target version changed from TBD to 9.0.0-beta1
  • Label deleted (Needs backport to 7.0)

OT Updated by OISF Ticketbot 16 days ago Actions #6

  • Subtask #8772 added

OT Updated by OISF Ticketbot 16 days ago Actions #7

  • Label deleted (Needs backport to 8.0)
Actions

Also available in: PDF Atom