Add Explicit Section for Prerequisites #1385
Conversation
| @@ -10,6 +10,9 @@ Radius consists of a set of tools and services that together form the Radius pla | |||
|
|
|||
| {{< image src="radius.png" alt="Diagram showing rad CLI and VSCode extension on local machine plus the Radius control plane on a Kubernetes cluster" width="600px" >}} | |||
|
|
|||
| ## Prerequisites | |||
| For edge version, Oras installation is required: https://oras.land/docs/installation. | |||
|
|
|||
| ## Step 1: Install the rad CLI | |||
|
|
|||
| {{< read file= "/shared-content/installation/rad-cli/install-rad-cli.md" >}} | |||
There was a problem hiding this comment.
Will remove it from step 1 https://github.com/radius-project/docs/blob/edge/docs/shared-content/installation/rad-cli/install-rad-cli.md?plain=1#L12 in next commit, if this structure looks good. Direct edit link on the docs website doesn't allow updating multiple files at once.
There was a problem hiding this comment.
I don't think you need to remove it from step 1 in https://github.com/radius-project/docs/blob/edge/docs/shared-content/installation/rad-cli/install-rad-cli.md?plain=1#L12 as the structure there is already set up such that the Oras prerequisite is only required in the edge version tab. It doesn't hurt to remind users again that they need Oras once they visit the edge tab within that page.
|
please address spelling check before merging, thanks! |
kachawla
force-pushed
the
kachawla-cli-install-docs
branch
from
0d72a07 to
c7a25d1
Compare
Egde version of Radius CLI installation requires Oras as a prerequisite. Currently it is bundled with rest of the content and is easy to miss until you hit an error while trying to install Radius CLI. Signed-off-by: Karishma Chawla <[email protected]>
kachawla
force-pushed
the
kachawla-cli-install-docs
branch
from
c7a25d1 to
b8dfa98
Compare
Updated. Thanks for the review. |
Signed-off-by: Karishma Chawla <[email protected]>
kachawla
force-pushed
the
kachawla-cli-install-docs
branch
from
b8dfa98 to
20723d4
Compare
* Add Explicit Section for Prerequisites Egde version of Radius CLI installation requires Oras as a prerequisite. Currently it is bundled with rest of the content and is easy to miss until you hit an error while trying to install Radius CLI. Signed-off-by: Karishma Chawla <[email protected]> * Ignore Oras from spellchecking Signed-off-by: Karishma Chawla <[email protected]> --------- Signed-off-by: Karishma Chawla <[email protected]>
Thank you for helping make the Radius documentation better!
Please follow this checklist before submitting:
In addition, please fill out the following to help reviewers understand this pull request:
Description
Egde version of Radius CLI installation requires Oras as a prerequisite. Currently it is bundled with rest of the content and is easy to miss until you hit an error while trying to install Radius CLI.
Issue reference