Create a reference section

Bug #2072354 reported by Jay Faulkner
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ironic
Fix Released
Low
Satoshi Shirosaka

Bug Description

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

Gather reference pages such as APIs and CLI references under a single "References" heading in the table of contents.

Reference information can be gathered in one omnibus section for the entire site, or each user guide can have its own reference chapter. You'll need to decide which makes the most sense for Ironic.

Here's a suggested outline for an omnibus reference section that includes existing reference sections in Ironic as well as reference sections that are standard across most software technical documentation:

- [Drivers, Hardware Types and Hardware Interfaces][ref1]
- [Configuration Reference][ref2]
- [API Reference (latest)][ref3]
- CLI references
  - `ironic` (link to [Ironic CLI][ironic-cli-ref])
  - `ironic-dbsync`[ironic-dbsync-ref]
  - `ironic-status`[ironic-status-ref]
- Glossary

[ref1]: https://docs.openstack.org/ironic/latest/admin/index.html#drivers-hardware-types-and-hardware-interfaces
[ref2]: https://docs.openstack.org/ironic/latest/configuration/index.html
[ref3]: https://docs.openstack.org/api-ref/baremetal/
[ironic-cli-ref]: https://docs.openstack.org/python-ironicclient/queens/cli/ironic_client.html
[ironic-dbsync-ref]: https://docs.openstack.org/ironic/latest/cli/ironic-dbsync.html
[ironic-status-ref]: https://docs.openstack.org/python-ironicclient/queens/cli/ironic_client.html

Changed in ironic:
status: New → Triaged
importance: Undecided → Low
Changed in ironic:
assignee: nobody → Satoshi Shirosaka (satoshi-sh)
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/+/940811

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/+/940811
Committed: https://opendev.org/openstack/ironic/commit/68f379582d851827c20c68c3f27381967ae871f5
Submitter: "Zuul (22348)"
Branch: master

commit 68f379582d851827c20c68c3f27381967ae871f5
Author: satoshi-sh <email address hidden>
Date: Wed Feb 5 10:12:53 2025 -0600

    Create a reference section

    Added a reference section to doc

    Closes-Bug: #2072354

    Change-Id: I586364b118307469b8c3fcefada68df11aa854a6

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