Add API reference

[lentzi90]

Similar to CAPIs API reference, create a section in the user guide with links to the relevant pages for https://doc.crds.dev and https://pkg.go.dev. We should have separate links for the Bare Metal Operator, Cluster API provider Metal3 and IP address manager.

Example for Bare Metal Operator:

• Custom Resource Definitions: https://doc.crds.dev/github.com/metal3-io/baremetal-operator@v0.5.0
• golang API documentation: https://pkg.go.dev/github.com/metal3-io/baremetal-operator/apis/metal3.io/v1alpha1

The code for the user guide can be found here.

[lentzi90]

/good-first-issue /triage accepted

[metal3-io-bot]

@lentzi90: This request has been marked as suitable for new contributors.

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-good-first-issue command.

In response to [this](https://github.com/metal3-io/metal3-docs/issues/402): >/good-first-issue >/triage accepted Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

[SafeEHA]

Hello @lentzi90 can you please assign this to me, also I need some clarification, In the folder structure, should it be a folder Reference at the tail end of the user-guide, then inside there would be files for Baremetal-operator, Ip-addresss-manger and Cluster API provider. For each of the files I'll then provide links for https://doc.crds.dev/ and https://pkg.go.dev/

For example Ip-address-manager file would contain https://doc.crds.dev/github.com/metal3-io/ip-address-manager and https://pkg.go.dev/github.com/metal3-io/ip-address-manager/api/v1alpha1

Is this correct?

[lentzi90]

Thanks for taking this up! /assign @SafeEHA

It sounds correct to me. Please note that the sidebar structure comes from SUMMARY.md. It actually doesn't look for the folder structure, but please keep it consistent so it is easier to navigate :smile:

Just like you said, we should have a separate point in the sidebar for Reference and then under that one for each of our main projects. :slightly_smiling_face:

[SafeEHA]

Kindly review https://github.com/metal3-io/metal3-docs/pull/406

[lentzi90]

Fixed in #406 Proof: https://book.metal3.io/reference /close

[metal3-io-bot]

@lentzi90: Closing this issue.

In response to [this](https://github.com/metal3-io/metal3-docs/issues/402#issuecomment-2100299217): >Fixed in #406 >Proof: https://book.metal3.io/reference >/close Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.