[DOCS-42] Allow for whole versions to be deprecated and end-of-lifed in read the docs Created: 27/Jun/17  Updated: 04/Jun/18  Resolved: 04/Jun/18

Status: Resolved
Project: docs
Component/s: read the docs
Affects Version/s: unspecified
Fix Version/s: None

Type: Bug
Reporter: Colin Dixon Assignee: Thanh Ha (zxiiro)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: 0 minutes
Time Spent: 30 minutes
Original Estimate: Not Specified
Environment:

Operating System: All
Platform: All


Attachments: PNG File Screenshot_20180119_162637.png    
External issue ID: 8759

 Description   

As we move versions of OpenDaylight to security-only patches and then unsupported, we should actively flag that fact in the docs for that version on all pages.

For example Django docs look like this for insecure versions:
https://docs.djangoproject.com/en/1.7/

And this for versions under development:
https://docs.djangoproject.com/en/dev/



 Comments   
Comment by Colin Dixon [ 27/Jun/17 ]

Preliminary patch:
https://git.opendaylight.org/gerrit/#/c/49856/

Comment by Umesh Kumar Singla [ 07/Jul/17 ]

There has been a significant improvement in that patch [0]. I have added it for stable/boron and stable/carbon branches as well. stable/beryllium is not allowing me to upload to Gerrit.

Need help for stable/lithium and previous branches, they have a different workflow. Or for me, it makes sense that we ignore those.

See the demo here [1]. Try switching the versions.

[0]: https://git.opendaylight.org/gerrit/#/c/49856/
[1]: test-odl-docs.readthedocs.io

Comment by Thanh Ha (zxiiro) [ 19/Jan/18 ]

I tried setting unsupported in my local branch and I am left with a simple text message embedded into the page header. I think we need to make sure it generates something more noticeable by the end user before we can consume this patch.

Comment by Thanh Ha (zxiiro) [ 04/Jun/18 ]

Fixed the issue with the patch. The class name for unsupported_warning did not match in the warning-header.css file causing the banner to not appear correctly.

Generated at Wed Feb 07 19:58:30 UTC 2024 using Jira 8.20.10#820010-sha1:ace47f9899e9ee25d7157d59aa17ab06aee30d3d.