Label references
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:/
[ref2]: https:/
[ref3]: https:/
Changed in ironic: | |
status: | New → Triaged |
importance: | Undecided → Wishlist |
Changed in ironic: | |
assignee: | nobody → Afonne-CID (cidelight) |
Fix proposed to branch: master /review. opendev. org/c/openstack /ironic/ +/925691
Review: https:/