Use gerunds for task headings

Bug #2072351 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.

Gerunds are "-ing" verbs. Here are examples of tasks sections from the current documentation, with suggested replacement titles:

| Current heading | Task phrasing |
| --------------- | ------------- |
| [Bare Metal Services Upgrade Guide][head1] | Upgrading Ironic |
| [Enrollment][head2] | Enrolling hardware with Ironic |
| [Node Deployment][head3] | Deploying a node on Ironic |
| [Node retirement][head4] | Retiring a node in Ironic |

Include the product name in each title so that it will be obvious in search entries. See [Search](#work-around-to-improve-search).

[head1]: https://docs.openstack.org/ironic/latest/user/index.html
[head2]: https://docs.openstack.org/ironic/latest/install/enrollment.html
[head3]: https://docs.openstack.org/ironic/latest/admin/node-deployment.html
[head4]: https://docs.openstack.org/ironic/latest/admin/retirement.html

Changed in ironic:
status: New → Triaged
importance: Undecided → Low
Afonne-CID (cidelight)
Changed in ironic:
assignee: nobody → Afonne-CID (cidelight)
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/+/925129

Changed in ironic:
status: Triaged → In Progress
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.