Rewrite page headings

Bug #2072349 reported by Jay Faulkner
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ironic
Triaged
Low
Unassigned

Bug Description

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

Name sections based on the type of information on the page as described in the following three sections:
- [Use gerunds for task headings](#use-gerunds-for-task-headings)
- [Label references](#label-references)
- [Use a description for concept headings](#use-a-description-for-concept-headings)

Search for and fix references to changed page titles within the documentation as you go.

Do this work in conjunction with the previous task, separating task, reference, and conceptual information. This will affect the entire documentation site and won't be completed all in one go.

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

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Related fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/ironic/+/925692

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix merged to ironic (master)

Reviewed: https://review.opendev.org/c/openstack/ironic/+/925129
Committed: https://opendev.org/openstack/ironic/commit/4750c4e9fa57e5381c4a63b0d22e5edd24b7d787
Submitter: "Zuul (22348)"
Branch: master

commit 4750c4e9fa57e5381c4a63b0d22e5edd24b7d787
Author: cid <email address hidden>
Date: Mon Jul 29 17:51:44 2024 +0100

    docs-audit-2024: Use gerunds for task headings

    Ironic docs improvements. Addressing one of the issues from
    the Ironic documentation audit. Using gerunds in titles and
    including *Ironic* in the title to improve SEO.

    Closes-Bug: #2072351
    Related-Bug: #2072349
    Change-Id: I9f9c47654386df416b51e8a0cd48f5a89f55e799

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on ironic (master)

Change abandoned by "cid <email address hidden>" on branch: master
Review: https://review.opendev.org/c/openstack/ironic/+/925692
Reason: Seems this change does not make the documentation better or just a poor attempt.

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.