Use links to configuration options in the documentation

Bug #2076111 reported by Dmitry Tantsur
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ironic
Fix Released
Low
Afonne-CID

Bug Description

We have a habit of mentioning configuration options like ``[group]option``. It's actually possible to provide a nice link to the rendered option documentation in the format of :oslo.config:option:`group.option`. For instance, :oslo.config:option:`conductor.workers_pool_size` will become a link to https://docs.openstack.org/ironic/latest/configuration/config.html#conductor.workers_pool_size.

Let us update the whole documentation to use this feature.

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/+/925756

Changed in ironic:
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to ironic (master)

Reviewed: https://review.opendev.org/c/openstack/ironic/+/925756
Committed: https://opendev.org/openstack/ironic/commit/582b2e991c15cccfe8fcca4443b12b21bd520e9b
Submitter: "Zuul (22348)"
Branch: master

commit 582b2e991c15cccfe8fcca4443b12b21bd520e9b
Author: cid <email address hidden>
Date: Tue Aug 6 10:35:57 2024 +0100

    Link to configuration options

    Implement cross-referencing to configuration options
    through out the Ironic documentation.

    Closes-Bug: #2076111
    Change-Id: I28712a3a92eb7e7d9875e49ea3ed8800168262fe

Changed in ironic:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/ironic 26.1.0

This issue was fixed in the openstack/ironic 26.1.0 release.

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.