Use gerunds for task headings
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]
[head1]: https:/
[head2]: https:/
[head3]: https:/
[head4]: https:/
Changed in ironic: | |
status: | New → Triaged |
importance: | Undecided → Low |
Changed in ironic: | |
assignee: | nobody → Afonne-CID (cidelight) |
Fix proposed to branch: master /review. opendev. org/c/openstack /ironic/ +/925129
Review: https:/