Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Explicit Section for Prerequisites #1385

Merged
merged 2 commits into from
Feb 27, 2025
Merged

Add Explicit Section for Prerequisites #1385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ce4312
Add Explicit Section for Prerequisites
kachawla Feb 5, 2025
20723d4
Ignore Oras from spellchecking
kachawla Feb 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/config/en-custom.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1295,3 +1295,5 @@ DaprConfigurationStorePropertiesMetadata
DaprConfigurationStoreProperties
configurationStores
configurationstores
Oras
oras
5 changes: 4 additions & 1 deletion docs/content/installation/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" >}}
Copy link
Contributor Author

@kachawla kachawla Feb 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Expand All @@ -22,4 +25,4 @@ Radius consists of a set of tools and services that together form the Radius pla

{{< read file= "/shared-content/installation/install-radius/initialize-radius.md" >}}

>If you are looking to upgrade Radius to the latest version, refer to [upgrade Radius on Kubernetes]({{< ref kubernetes-upgrade >}}) for more information.
>If you are looking to upgrade Radius to the latest version, refer to [upgrade Radius on Kubernetes]({{< ref kubernetes-upgrade >}}) for more information.
Loading