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

[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

[metal3-io-bot]

@dtantsur:
This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

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

Migrate from https://github.com/metal3-io/baremetal-operator/blob/main/docs/api.md

/kind documentation
/help

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[dtantsur]

/triage accepted

[metal3-io-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues will close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

/lifecycle stale

[dtantsur]

/remove-lifecycle stale
/lifecycle frozen

[SafeEHA]

@Rozzii i'll be happy help with this

[Rozzii]

@SafeEHA thanks!
/assign @SafeEHA

[Rozzii]

/remove-lifecycle frozen

[SafeEHA]

Hi @Rozzii
I missed this last week, so just to be clear I am to migrate the api.md file and baremetalhost-states.md file to some other directory?

Then also sync (merge) inspectAnnotation.md file and statusAnnotation.md files into just a single file ?

[Rozzii]

Hi @Rozzii I missed this last week, so just to be clear I am to migrate the api.md file and baremetalhost-states.md file to some other directory?

Then also sync (merge) inspectAnnotation.md file and statusAnnotation.md files into just a single file ?

The goal would be to have all the documentation in the metal3-docs user-guide. Yes the you would need to merge the two annotations files to one. IMO everything can be relocated to metal3-doc user-guide but if @dtantsur thinks it is better to leave the status annotation doc here that is fine by me too.

[SafeEHA]

@Rozzii To confirm, i'll be moving the api.md file and baremetalhost-states.md to the "basic features" section of the Baremetal Operator in the user-guide?
Also, can i name the status annotation and inspect annotation files annotation.md after merging both?

[SafeEHA]

Just created this, I see the reviewers of PRs in the BMO repo aren't you guys...can you help take a look @Rozzii and let me know if it's what you had in mind?

[tuminoid]

@Rozzii To confirm, i'll be moving the api.md file and baremetalhost-states.md to the "basic features" section of the Baremetal Operator in the user-guide? Also, can i name the status annotation and inspect annotation files annotation.md after merging both?

I think the descriptions says to move docs from BMO to here, and then sync BMO side docs to reference the new docs here to avoid duplication.

[SafeEHA]

Thanks for pointing this out @dtantsur, i've done just that in Pull #475

[Rozzii]

@Rozzii To confirm, i'll be moving the api.md file and baremetalhost-states.md to the "basic features" section of the Baremetal Operator in the user-guide? Also, can i name the status annotation and inspect annotation files annotation.md after merging both?

I have started to type a response to you but got distracted, sorry.
I am in agreement with @tuminoid so stuff should land here in user-guide and BMO should reference them if needed. I have checked your PR and it looks good to me.