Project

General

Profile

Actions

Documentation #6442

open

rtd: indicate that a page is for an outdated version

Added by Juliana Fajardini Reichow over 1 year ago. Updated 6 days ago.

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

Description

If a visitor visits a page like https://docs.suricata.io/en/suricata-6.0.0/install.html they should
see a warning that such version is out of date.


Subtasks 2 (1 open1 closed)

Documentation #6516: rtd: indicate that a page is for an outdated version (6.0.x backport)RejectedActions
Documentation #6519: rtd: indicate that a page is for an outdated version (7.0.x backport)AssignedJuliana Fajardini ReichowActions
Actions #2

Updated by Victor Julien over 1 year ago

  • Target version changed from 7.0.3 to 8.0.0-beta1
  • Label Needs backport to 6.0, Needs backport to 7.0 added
Actions #3

Updated by OISF Ticketbot over 1 year ago

  • Subtask #6516 added
Actions #4

Updated by OISF Ticketbot over 1 year ago

  • Label deleted (Needs backport to 6.0)
Actions #5

Updated by OISF Ticketbot over 1 year ago

  • Subtask #6519 added
Actions #6

Updated by OISF Ticketbot over 1 year ago

  • Label deleted (Needs backport to 7.0)
Actions #7

Updated by Jason Ish over 1 year ago

Through experimentation, and confirmation from RTD support, tags must be parseable semantic versions for this to work. Our tag scheme, suricata-x.y.z is not due to the prefixing before the version.

Others have run into this issue as well and there is an open ticket for a feature that may help those with tags that aren't exactly semver: https://github.com/readthedocs/readthedocs.org/issues/5318

Actions #8

Updated by Victor Julien 6 months ago

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

Updated by Victor Julien about 1 month ago

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

Updated by Victor Julien 29 days ago

  • Target version changed from 8.0.0 to 9.0.0-beta1
Actions #11

Updated by Juliana Fajardini Reichow 6 days ago

How do we feel about this?
The ticket that could help is still open...

Actions #12

Updated by Jason Ish 6 days ago

Juliana Fajardini Reichow wrote in #note-11:

How do we feel about this?
The ticket that could help is still open...

This is still an issue. It would be nice to fix sooner than the 9.0 cycle though, as it does lead to confusion.. And will again after master and 8.0 diverge.

Actions #13

Updated by Juliana Fajardini Reichow 6 days ago

So do we come up with some sort of workaround, since a more automated way isn't possible yet?

Actions #14

Updated by Jason Ish 6 days ago

Juliana Fajardini Reichow wrote in #note-13:

So do we come up with some sort of workaround, since a more automated way isn't possible yet?

I don't know what it would be, but even without a work-around or possible one, its a known issue. So the ticket can stay open I think.

One possible option I suppose is a shadow-repo that follows tags that RTD expects. By that I mean, just another Suricata repo that exists purely for documentation. Seems like a bad hack though.

Actions #15

Updated by Juliana Fajardini Reichow 6 days ago

Jason Ish wrote in #note-14:

I don't know what it would be, but even without a work-around or possible one, its a known issue. So the ticket can stay open I think.

okie

One possible option I suppose is a shadow-repo that follows tags that RTD expects. By that I mean, just another Suricata repo that exists purely for documentation. Seems like a bad hack though.

indeed...

Actions

Also available in: Atom PDF