docs have incorrect indentation

Bug #1712860 reported by Ruby Loo
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ironic
Fix Released
Low
Ruby Loo

Bug Description

The ironic docs have incorrect indentation in various parts/pages. They end up being rendered with a grey-vertical line to the left of the text.

Example:
https://docs.openstack.org/ironic/pike/admin/drivers/ilo.html#glance-configuration

I used a pike page as an example, because I don't think that page will change. I think the fix should only be done on master, it doesn't seem urgent enough to backport.

The fixes should be simple; the hard part might be finding *all* occurrences of these.

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

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

Changed in ironic:
assignee: nobody → Shivanand Tendulker (stendulker)
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to ironic (master)

Reviewed: https://review.openstack.org/497971
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=cb793d013610e6905f58c823e68580714991e2df
Submitter: Jenkins
Branch: master

commit cb793d013610e6905f58c823e68580714991e2df
Author: Shivanand Tendulker <email address hidden>
Date: Fri Aug 25 09:22:39 2017 -0400

    Fix indentation in few of the documentation pages

    Partial-Bug: #1712860
    Change-Id: Id467f5a917e61643823a9d82faa94516ea250f43

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

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to ironic (master)

Reviewed: https://review.openstack.org/499081
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=92e451c1af3a9590d8a701901f8adb58f5bb9341
Submitter: Jenkins
Branch: master

commit 92e451c1af3a9590d8a701901f8adb58f5bb9341
Author: Shivanand Tendulker <email address hidden>
Date: Wed Aug 30 05:17:48 2017 -0400

    Follow-up for commit cb793d013610e6905f58c823e68580714991e2df

    Addresses a pending comment given in commit
    cb793d013610e6905f58c823e68580714991e2df

    Change-Id: I7f0e88a78409dd4c57dbe20f9fc1d80cf625b529
    Partial-Bug: #1712860

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to ironic (stable/pike)

Fix proposed to branch: stable/pike
Review: https://review.openstack.org/500557

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

Reviewed: https://review.openstack.org/500557
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=b57ef5643270da57b3c485106065fcdaa7b417bd
Submitter: Jenkins
Branch: stable/pike

commit b57ef5643270da57b3c485106065fcdaa7b417bd
Author: Shivanand Tendulker <email address hidden>
Date: Fri Aug 25 09:22:39 2017 -0400

    Fix indentation in few of the documentation pages

    Partial-Bug: #1712860
    Change-Id: Id467f5a917e61643823a9d82faa94516ea250f43
    (cherry picked from commit cb793d013610e6905f58c823e68580714991e2df)

tags: added: in-stable-pike
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to ironic (master)

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

Changed in ironic:
assignee: Shivanand Tendulker (stendulker) → Ruby Loo (rloo)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to ironic (master)

Reviewed: https://review.openstack.org/501442
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=72f8b11e338e5cc2b2e0f81aece550d6969a1a03
Submitter: Jenkins
Branch: master

commit 72f8b11e338e5cc2b2e0f81aece550d6969a1a03
Author: Ruby Loo <email address hidden>
Date: Wed Sep 6 17:00:11 2017 -0400

    reformat REST API Version History page

    This reformats the REST API Version History page so that:

    * the ugly indents are gone
    * each API version is in its own section and appears in the page
      contents (bottom, left-hand-side)
    * added semver numbers of the ironic release where the API version
      was introduced

    Change-Id: I37cdb7dcc4ebbc367ead277488ed805694a19450
    Partial-Bug: #1712860

Revision history for this message
Ruby Loo (rloo) wrote :

It is possible there are issues still, but this will be on-going. Probably don't need to open a bug to fix any of these, just propose a PR.

Changed in ironic:
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.