Use a description for concept headings

Bug #2072353 reported by Jay Faulkner
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ironic
In Progress
Low
Afonne-CID

Bug Description

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

Head conceptual sections with a descriptive title. Avoid extraneous words like "About" and "A guide to ...". "Overview" and "Introduction" are OK in headings.

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

| Current heading | Concept phrasing |
| --------------- | ---------------- |
| [Bare Metal service overview][con1] | Overview of Ironic |
| [Understanding Bare Metal service][con2] |Overview of Ironic (Combine with previous entry.) |
| [REST API Conceptual Guide][con3] | REST API Overview for Ironic (Only if there is more explanatory material added. Otherwise call it "REST API versioning for Ironic" since that's all it currently describes.) |

[con1]: https://docs.openstack.org/ironic/latest/install/get_started.html
[con2]: https://docs.openstack.org/ironic/latest/user/architecture.html
[con3]: https://docs.openstack.org/ironic/latest/contributor/webapi.html

Changed in ironic:
status: New → Triaged
importance: Undecided → Low
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/+/925692

Changed in ironic:
status: Triaged → In Progress
Afonne-CID (cidelight)
Changed in ironic:
assignee: nobody → Afonne-CID (cidelight)
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.