Skip to content

User-guide: migrate BareMetalHost and HardwareData API docs from BMO #314

@dtantsur

Description

@dtantsur

We need to have user-facing content in the user guide. I suggest we have a single page for BMH and HardwareData.

Migrate the description from https://github.com/metal3-io/baremetal-operator/blob/main/docs/api.md
Migrate state machine from https://github.com/metal3-io/baremetal-operator/blob/main/docs/baremetalhost-states.md (with images)
Synchronize and delete BMO copies of https://github.com/metal3-io/baremetal-operator/blob/main/docs/inspectAnnotation.md
and https://github.com/metal3-io/baremetal-operator/blob/main/docs/statusAnnotation.md

/kind documentation
/help

Metadata

Metadata

Assignees

No one assigned

    Labels

    help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.kind/documentationCategorizes issue or PR as related to documentation.lifecycle/frozenIndicates that an issue or PR should not be auto-closed due to staleness.triage/acceptedIndicates an issue is ready to be actively worked on.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions