Old EOL-ed release landing pages have master (up-to-date) document links

Bug #1691058 reported by Ian Y. Choi
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Security Guide Documentation
Fix Released
Undecided
Farhan Kalsekar
openstack-manuals
Fix Released
Low
Farhan Kalsekar

Bug Description

There are landing pages for EOL-ed releases such as kilo and liberty:

https://docs.openstack.org/kilo/
https://docs.openstack.org/liberty/

The problem is that the pages also have links for Administrator Guide, High Availability Guide,
Operations Guide, Security Guide, Virtual Machine Image Guide, Architecture Design Guide,
API Guide (api-quick-start), End User Guide, and so on for "master" branches.

Master branch documentation usually contains the content with up-to-date releases, not previous releases.
New users might be so confused.

I think the candidate solutions are:

- Remove all links for master branch documents
- Adds an explanation: the master branch documents may not have kilo/liberty explanations.

Changed in openstack-manuals:
status: New → Confirmed
importance: Undecided → Low
milestone: none → pike
Changed in openstack-manuals:
assignee: nobody → Farhan Kalsekar (ifarhan)
Revision history for this message
Farhan Kalsekar (ifarhan) wrote :

Some of the docs like the Admin guide, HA guide, Security guide etc does explicitly state at the start

"This guide documents OpenStack Ocata, Newton, and Mitaka releases."

Would adding this line to the other docs as applicable be an acceptable solution?

Revision history for this message
Olena Logvinova (ologvinova) wrote :

@ifarhan, where exactly do you propose to add this line to? Probably, it's worth expanding the existing note by adding that kilo/liberty may not be applicable to the master version of these guides.

Revision history for this message
Farhan Kalsekar (ifarhan) wrote :

@ologvinova After having a second look, the rest of the docs like Operations Guide, Architecture Design Guide and Virtual Machine Image Guide may not be release-dependent and hence may not require the note.
I will update the existing note in the docs to explicitly state that they may not be applicable to EOL release kilo/liberty.

Revision history for this message
Olena Logvinova (ologvinova) wrote :

Thanks Farhan, sounds good!

Changed in ossp-security-documentation:
assignee: nobody → Farhan Kalsekar (ifarhan)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-manuals (master)

Fix proposed to branch: master
Review: https://review.openstack.org/468986

Changed in openstack-manuals:
status: Confirmed → In Progress
Revision history for this message
Farhan Kalsekar (ifarhan) wrote :

I took the liberty to add you as the reviewer for https://review.openstack.org/#/c/468986/

Changed in openstack-manuals:
assignee: Farhan Kalsekar (ifarhan) → Alexandra Settle (alexandra-settle)
Changed in openstack-manuals:
assignee: Alexandra Settle (alexandra-settle) → Farhan Kalsekar (ifarhan)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-manuals (master)

Reviewed: https://review.openstack.org/468986
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=fe19908eb866cb597f9ce2f9d121a30caaf8cbe8
Submitter: Jenkins
Branch: master

commit fe19908eb866cb597f9ce2f9d121a30caaf8cbe8
Author: Farhan Kalsekar <email address hidden>
Date: Tue May 30 14:02:41 2017 +1000

    Add note for EOL releases to the master version of guides.

    admin-guide and ha-guide updated to explicitly state
    that content may not apply to EOL releases Kilo and Liberty.

    Also applies to Security Guide and hence will fix it in the
    ossp-security-documentation project.

    Change-Id: I9d4711f853004193f9aeea3f64b6081e0efeb5b2
    Partial-Bug: #1691058

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to security-doc (master)

Fix proposed to branch: master
Review: https://review.openstack.org/470059

Changed in ossp-security-documentation:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to security-doc (master)

Reviewed: https://review.openstack.org/470059
Committed: https://git.openstack.org/cgit/openstack/security-doc/commit/?id=f8a4a80e21016b0f7395659f44243dd909e0ffff
Submitter: Jenkins
Branch: master

commit f8a4a80e21016b0f7395659f44243dd909e0ffff
Author: Farhan Kalsekar <email address hidden>
Date: Fri Jun 2 09:07:47 2017 +1000

    Update note to mention Ocata and EOL releases

    Security guide updated to include Ocata as supported release
    and mention that content may not apply for EOL releases.

    Change-Id: I5d0c7c238629e79db9e660c267f2c59b4cd943ff
    Closes-Bug:#1694187
    Partial-Bug: #1691058

Luke Hinds (lhinds)
Changed in ossp-security-documentation:
status: In Progress → Fix Released
Changed in openstack-manuals:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.