From 91f4510b1a737b13605a4abc78973fd1d9255117 Mon Sep 17 00:00:00 2001 From: Noor Muhammad Malik Date: Tue, 5 Jan 2021 17:25:12 +0500 Subject: [PATCH] Fix incorrect links in Hardware Profile Documentation 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 --- docs/source/hardware_profile.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/source/hardware_profile.md b/docs/source/hardware_profile.md index 1cfd1c1bb..2d2e9a1c1 100644 --- a/docs/source/hardware_profile.md +++ b/docs/source/hardware_profile.md @@ -1,13 +1,13 @@ # Hardware Profile Guide 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. ## The Host Generator M3 Function 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 inputs and provides BMH documents as outputs, making it easier to generate a large set of BMH documents efficiently. @@ -66,9 +66,11 @@ of using these levels in your configurations are given 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]. [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 +[3]: https://github.com/metal3-io/baremetal-operator/tree/master/apis/metal3.io/v1alpha1