docs: add contributor guide for writing Ironic drivers and interfaces - #2315
Draft
cardoe wants to merge 3 commits into
Draft
docs: add contributor guide for writing Ironic drivers and interfaces#2315cardoe wants to merge 3 commits into
cardoe wants to merge 3 commits into
Conversation
The audit landed in #2190, just before the release-notes work in #2191. Re-check every claim against main: counts move to 137 pages, 8 nav entries, 61 external markdown files and v0.4.28. Add three mechanics the reorg must respect -- the generated-but-navigated unreleased.md, include_dir_to_nav's global sort toggle, and the published release-body URLs that pin docs/release-notes/ permanently. Grow the proposal a seventh tab. Also fix the audit's own errors: the rename impact lists, Phase 3's link count, and a component table row that was never there.
Phase 1 of docs-layout-audit.md: give each audience a front door. Nav-only, no file moves, so no in-repo link and no published URL changes but the one deletion. Adds the missing Contributing and Reference front doors and a troubleshooting hub to land on from a pager, rewrites user-guide/index.md and the Home cards, and regroups Operations by operator role to dissolve the 17-page Infrastructure dumping ground. Deletes the design-guide/intro.md stub, redirected via mkdocs-redirects. Verified with properdocs build --strict and markdownlint.
Contributors adding hardware support to ironic-understack currently have no Ironic-specific onboarding: the hardware-type/interface model, the provisioning state machine, and the mixin pattern the existing drivers use are undocumented outside upstream OpenStack docs and the source itself. Cover that ground, with extra depth on writing an inspect/ management interface for devices that have no BMC or deploy ramdisk (e.g. network gear), since that's the next class of driver expected.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this change do?
Contributors adding hardware support to ironic-understack currently have
no Ironic-specific onboarding: the hardware-type/interface model, the
provisioning state machine, and the mixin pattern the existing drivers
use are undocumented outside upstream OpenStack docs and the source
itself. Cover that ground, with extra depth on writing an inspect/
management interface for devices that have no BMC or deploy ramdisk
(e.g. network gear), since that's the next class of driver expected.
Upgrade impact
upgrade-impactlabel and a release note: runscriv createfrom therepository root and describe the required action in the generated
changelog.d/file. See RELEASING.md.Operator action means anything a deployment has to do beyond a normal resync:
deploy repo or values changes, new or removed secrets, enabling or disabling a
component, or a manual one-time step.