Project

Profile

Help

Task #831

Incorrect banners on RTD pages

Added by bmbouter over 5 years ago. Updated over 1 year ago.

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

0%

Estimated time:
Platform Release:
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation, Pulp 2
Sprint:
Quarter:

Description

Background:
RTD uses branch names to determine if a user is browsing the latest version or not. If you are not on the latest version, you will be shown a banner claiming the docs you are on are out of date like this one.

The issue:
RTD "incorrectly determines if a branch is the latest or not"https://github.com/rtfd/readthedocs.org/issues/1207. This has caused situations where banners are displayed on the production docs incorrectly claiming they are out of date for the development docs.

Expected behavior:
I expect the latest public version to not show a banner saying it is out of date. I also expect any non-latest versions to show a banner that their docs are out of date.

Recommended fix:
We cannot fix this in Pulp. It needs to be fixed in the upstream bug [0] in RTD.

[0]: https://github.com/rtfd/readthedocs.org/issues/1207


Related issues

Related to Pulp - Task #950: Consolidate platform and plugin docs into a static site.CLOSED - CURRENTRELEASE

<a title="Actions" class="icon-only icon-actions js-contextmenu" href="#">Actions</a>
Blocks Pulp - Issue #840: Beta and release candidate documentation is not availableCLOSED - CURRENTRELEASE<a title="Actions" class="icon-only icon-actions js-contextmenu" href="#">Actions</a>

History

#1 Updated by bmbouter over 5 years ago

  • Description updated (diff)
  • Tags Documentation added

#2 Updated by bmbouter over 5 years ago

  • Related to Issue #840: Beta and release candidate documentation is not available added

#3 Updated by bmbouter over 5 years ago

  • Related to deleted (Issue #840: Beta and release candidate documentation is not available)

#4 Updated by bmbouter over 5 years ago

  • Blocks Issue #840: Beta and release candidate documentation is not available added

#5 Updated by bmbouter over 5 years ago

  • Related to Task #950: Consolidate platform and plugin docs into a static site. added

#6 Updated by bmbouter over 4 years ago

  • Sprint Candidate changed from No to Yes

#7 Updated by mhrivnak over 4 years ago

  • Sprint Candidate changed from Yes to No

#8 Updated by bmbouter over 4 years ago

  • Status changed from NEW to CLOSED - CURRENTRELEASE

We no longer use RTD so this is not a problem anymore.

#9 Updated by bmbouter over 1 year ago

  • Tags Pulp 2 added

Please register to edit this issue

Also available in: Atom PDF