Doc: There is no branch for role documentation

Bug #1620233 reported by Jean-Philippe Evrard
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack-Ansible
Fix Released
Wishlist
Jimmy McCrory

Bug Description

There is currently no branching in each of the roles' documentation.

This seems fine for now, but as Ocata will be out, we'd probably want to have an ocata branch for the documentation, but ALSO have a way to select the branch we want documentation for when reading the web pages.

Revision history for this message
Jesse Pretorius (jesse-pretorius) wrote :

Actually, we need to reference the branch name in the install guide so that the right branch is linked. Each role does already have branch docs. See http://docs.openstack.org/developer/openstack-ansible-os_cinder/mitaka/ as an example.

I've registered https://bugs.launchpad.net/openstack-ansible/+bug/1620367 as an idea to make the maintenance of references easier.

Changed in openstack-ansible:
status: New → Confirmed
importance: Undecided → Wishlist
Revision history for this message
Jean-Philippe Evrard (jean-philippe-evrard) wrote :
Changed in openstack-ansible:
assignee: nobody → Jimmy McCrory (jimmy-mccrory)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-ansible (master)

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

Changed in openstack-ansible:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-ansible (master)

Reviewed: https://review.openstack.org/433762
Committed: https://git.openstack.org/cgit/openstack/openstack-ansible/commit/?id=92ccc1b8cda9c31c39a375fffe20561d24340745
Submitter: Jenkins
Branch: master

commit 92ccc1b8cda9c31c39a375fffe20561d24340745
Author: Jimmy McCrory <email address hidden>
Date: Tue Feb 14 02:15:40 2017 -0800

    [DOCS] Include branch in links to role docs

    Create a new external link alias for role docs to simplify adding links
    for them within the deploy guide and to automatically include the
    correct branch name within those links.

    Closes-Bug: 1620233
    Change-Id: I02a474fabe5c1a7499e828c4661cf6b232886409

Changed in openstack-ansible:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-ansible (stable/ocata)

Fix proposed to branch: stable/ocata
Review: https://review.openstack.org/433849

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-ansible (stable/ocata)

Reviewed: https://review.openstack.org/433849
Committed: https://git.openstack.org/cgit/openstack/openstack-ansible/commit/?id=f32abc06101c63cb165ce6bc34852980f75ded04
Submitter: Jenkins
Branch: stable/ocata

commit f32abc06101c63cb165ce6bc34852980f75ded04
Author: Jimmy McCrory <email address hidden>
Date: Tue Feb 14 02:15:40 2017 -0800

    [DOCS] Include branch in links to role docs

    Create a new external link alias for role docs to simplify adding links
    for them within the deploy guide and to automatically include the
    correct branch name within those links.

    Closes-Bug: 1620233
    Change-Id: I02a474fabe5c1a7499e828c4661cf6b232886409
    (cherry picked from commit 92ccc1b8cda9c31c39a375fffe20561d24340745)

tags: added: in-stable-ocata
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/openstack-ansible 15.0.0.0rc2

This issue was fixed in the openstack/openstack-ansible 15.0.0.0rc2 release candidate.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/openstack-ansible 16.0.0.0b1

This issue was fixed in the openstack/openstack-ansible 16.0.0.0b1 development milestone.

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.