Project

Profile

Help

Story #2673

closed

As a user browsing on docs.pulpproject.org, I can see a banner displaying when I am browsing docs of an unsupported release

Added by bmbouter about 7 years ago. Updated almost 5 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
% Done:

0%

Estimated time:
Platform Release:
2.14.0
Groomed:
Yes
Sprint Candidate:
Yes
Tags:
Pulp 2
Sprint:
Quarter:

Description

A banner should be put on the top of every page docs page saying "This documentation is for an unsupported version of Pulp. Consider upgrading to a supported version."

For example something like what the Celery docs have: http://docs.celeryproject.org/en/3.1/userguide/workers.html

After discussion below a dynamic approach should be used. This involves creating a new 'supported_releases.json' file hosted at https://github.com/pulp/pulp_packaging/tree/master/ci/config/releases/ with all x.y strings in it as a list. Here is an example with 2.12 and 3.0 showing as supported:

["2.12", "3.0"]

Then some javascript should check the docs version of the current page and if it is not in the x.y stream that is supported, show the banner.

Also available in: Atom PDF