Label references

Bug #2072352 reported by Jay Faulkner
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ironic
Fix Released
Wishlist
Afonne-CID

Bug Description

This issue was an action item from the Ironic documentation audit.

Label every reference as "reference" (for products and interfaces) or "specification" (for things that conform to a spec, like protocols and RFPs).

Examples of reference sections from the current documentation, with suggested replacement titles:

| Current heading | Reference phrasing |
| --------------- | ------------------ |
| [Drivers, Hardware Types and Hardware Interfaces][ref1] | Hardware interface reference for Ironic |
| [Configuration Reference][ref2] | Configuration reference for Ironic |
| [API Reference (latest)][ref3] | API reference for Ironic |

[ref1]: https://docs.openstack.org/ironic/latest/admin/index.html#drivers-hardware-types-and-hardware-interfaces
[ref2]: https://docs.openstack.org/ironic/latest/configuration/index.html
[ref3]: https://docs.openstack.org/api-ref/baremetal/

Changed in ironic:
status: New → Triaged
importance: Undecided → Wishlist
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to ironic (master)

Fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/ironic/+/925691

Changed in ironic:
status: Triaged → In Progress
Afonne-CID (cidelight)
Changed in ironic:
assignee: nobody → Afonne-CID (cidelight)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to ironic (master)

Reviewed: https://review.opendev.org/c/openstack/ironic/+/925691
Committed: https://opendev.org/openstack/ironic/commit/17ba2b3db75d8f4763c9bb48573e3fcd66470ad8
Submitter: "Zuul (22348)"
Branch: master

commit 17ba2b3db75d8f4763c9bb48573e3fcd66470ad8
Author: cid <email address hidden>
Date: Mon Aug 5 13:18:07 2024 +0100

    docs-audit-2024: Labeling references

    Rewrite page headings with correct labeling for references
    and specifications.

    Closes-Bug: #2072352
    Related-Bug: #2072349
    Change-Id: I82313c18294ff8572ae6a6a02607068370f195c3

Changed in ironic:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/ironic 26.1.0

This issue was fixed in the openstack/ironic 26.1.0 release.

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.