Documentation #6442
openrtd: indicate that a page is for an outdated version
Added by Juliana Fajardini Reichow almost 2 years ago. Updated 22 days ago.
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.
Updated by Shivani Bhardwaj almost 2 years ago
Perhaps useful and worth a try to look at: https://michaelgoerz.net/notes/showing-a-warning-for-the-latest-documentation-on-readthedocs/index.html
Updated by Victor Julien almost 2 years 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
Updated by OISF Ticketbot almost 2 years ago
- Label deleted (
Needs backport to 6.0)
Updated by OISF Ticketbot almost 2 years ago
- Label deleted (
Needs backport to 7.0)
Updated by Jason Ish almost 2 years 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
Updated by Victor Julien 9 months ago
- Target version changed from 8.0.0-beta1 to 8.0.0-rc1
Updated by Victor Julien 4 months ago
- Target version changed from 8.0.0-rc1 to 8.0.0
Updated by Victor Julien 4 months ago
- Target version changed from 8.0.0 to 9.0.0-beta1
Updated by Juliana Fajardini Reichow 3 months ago
How do we feel about this?
The ticket that could help is still open...
Updated by Jason Ish 3 months 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.
Updated by Juliana Fajardini Reichow 3 months ago
So do we come up with some sort of workaround, since a more automated way isn't possible yet?
Updated by Jason Ish 3 months 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.
Updated by Juliana Fajardini Reichow 3 months 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...