Project

Profile

Help

Issue #840

Beta and release candidate documentation is not available

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:
Estimated time:
Severity:
3. High
Version:
Platform Release:
OS:
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation, Pulp 2
Sprint:
Quarter:

Description

When users go to use an beta or a release candidate, there isn't a clear place to read the docs from. When we publish a beta or RC, we should include a link to the docs. This builder should also be used by QE for docs bug verification and reference to the docs for the release they are testing.

==== NOTE ===

We should use RTD Private builders, but we cannot until #831 is resolved because any private builders of newer Y releases will cause the production docs to receive a banner that they are out of date and that the unreleased docs are the current up to date ones (which is bad).

==== NOTE ===

Private builders are not publicly shown, and not indexed by search engines because the link to them is hard to find. If you have the link you can view the docs without any authentication.

Update the build docs so that when a beta or RC is published, the builder ensures a 'Private' builder in RTD is enabled. Have that builder build against the *-testing branch containing the beta or RC. Users and QE can be linked to that.


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>
Blocked by Pulp - Task #831: Incorrect banners on RTD pagesCLOSED - CURRENTRELEASE

<a title="Actions" class="icon-only icon-actions js-contextmenu" href="#">Actions</a>

History

#1 Updated by bmbouter over 5 years ago

  • Related to Task #831: Incorrect banners on RTD pages added

#2 Updated by bmbouter over 5 years ago

  • Description updated (diff)

#3 Updated by mhrivnak over 5 years ago

  • Triaged changed from No to Yes
  • Tags deleted (Easy Fix)

#4 Updated by bmbouter over 5 years ago

  • Description updated (diff)

#5 Updated by bmbouter over 5 years ago

  • Description updated (diff)

#6 Updated by bmbouter over 5 years ago

  • Related to deleted (Task #831: Incorrect banners on RTD pages)

#7 Updated by bmbouter over 5 years ago

  • Blocked by Task #831: Incorrect banners on RTD pages added

#8 Updated by bmbouter over 5 years ago

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

#9 Updated by bmbouter about 4 years ago

  • Status changed from NEW to CLOSED - CURRENTRELEASE

We now publish beta and RC documentation so I'm closing this as CURRENTRELEASE

#10 Updated by bmbouter over 1 year ago

  • Tags Pulp 2 added

Please register to edit this issue

Also available in: Atom PDF