airship/airshipctl
Code Issues Proposed changes

Fix incorrect links in Hardware Profile Documentation

Browse Source 
There was an issue that pointed out incorrect references to the
metal3 API within the Hardware Profile section of Airship 2.0
documentation. They are currently pointing to the API docs and
not the API itself. This patch addresses that issue and updates
the link as suggested.

I've kept the last reference intact, since it points to the API
documentation itself and doesn't require a change.

Relates-To: #422
Closes: #422
Change-Id: I37254a64a27b3cdf2675721b0f1f62d41913915c
This commit is contained in:
Noor Muhammad Malik 2021-01-05 17:25:12 +05:00
parent 1016a29870
commit 91f4510b1a
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/source/hardware_profile.md
View File

@ -1,13 +1,13 @@
# Hardware Profile Guide # Hardware Profile Guide
This document explains the functionality of RAID and firmware configuration This document explains the functionality of RAID and firmware configuration
that is available in airshipctl. This will assist to author [Baremetal Host][1] that is available in airshipctl. This will assist to author [Baremetal Host][3]
documents with added RAID and firmware functionality. documents with added RAID and firmware functionality.
## The Host Generator M3 Function ## The Host Generator M3 Function
Airshipctl has a `hostgenerator-m3` function which it uses to generate Metal3 Airshipctl has a `hostgenerator-m3` function which it uses to generate Metal3
[Baremetal Host][1] documents. This generator uses a `hosttemplate` to [Baremetal Host][3] documents. This generator uses a `hosttemplate` to
templatize a BMH specification. It takes a set of parameters and a template as templatize a BMH specification. It takes a set of parameters and a template as
inputs and provides BMH documents as outputs, making it easier to generate inputs and provides BMH documents as outputs, making it easier to generate
a large set of BMH documents efficiently. a large set of BMH documents efficiently.
@ -66,9 +66,11 @@ of using these levels in your configurations are given
rotataional: False rotataional: False
``` ```
For additional detail on these parameters, see the [Baremetal Host][1] doc. For additional detail on these parameters, see the [Baremetal Host][1] API
documentation.
For more details on the example hardwareprofile, see [the repo][2]. For more details on the example hardwareprofile, see [the repo][2].
[1]: https://github.com/metal3-io/baremetal-operator/blob/master/docs/api.md [1]: https://github.com/metal3-io/baremetal-operator/blob/master/docs/api.md
[2]: https://opendev.org/airship/airshipctl/src/branch/master/manifests/function/hardwareprofile-example [2]: https://opendev.org/airship/airshipctl/src/branch/master/manifests/function/hardwareprofile-example
[3]: https://github.com/metal3-io/baremetal-operator/tree/master/apis/metal3.io/v1alpha1