Very small updates to Getting Started #1015
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
small updates for clarity Signed-off-by: Omer Bensaadon <[email protected]>
omerbensaadon
commented
Jan 4, 2024
| @@ -77,7 +77,7 @@ In addition to starting Radius services in your Kubernetes cluster, this initial | |||
|
|
|||
| ## 4. Run the app | |||
|
|
|||
| Use the below command to run the app in your environment, then access the application by opening [http://localhost:3000](http://localhost:3000) in a browser. | |||
| Use the below command to run the app in your environment: | |||
There was a problem hiding this comment.
feels more natural to put the link after the command is run, I was left sort of looking for it
omerbensaadon
commented
Jan 4, 2024
omerbensaadon
commented
Jan 4, 2024
| In this step you will: | ||
|
|
||
| - Add Redis to the application using a Recipe. | ||
| - Add Redis to the application using a [Recipe]({{< ref "guides/recipes/overview" >}}) . |
There was a problem hiding this comment.
Feels like a situation where talking about Recipes is actually a bit distracting from the main purpose of the Getting Started.
Linking to the concept here is enough I think?
There was a problem hiding this comment.
Agree on linking to Recipes being enough. Small update:
Suggested change
| - Add Redis to the application using a [Recipe]({{< ref "guides/recipes/overview" >}}) . | |
| - Adding a Redis Cache to your app definition, leveraging [Recipes]({{< ref "guides/recipes/overview" >}}) for the underlying infrastructure. |
AaronCrawfis
suggested changes
Jan 4, 2024
| In this step you will: | ||
|
|
||
| - Add Redis to the application using a Recipe. | ||
| - Add Redis to the application using a [Recipe]({{< ref "guides/recipes/overview" >}}) . |
There was a problem hiding this comment.
Agree on linking to Recipes being enough. Small update:
Suggested change
| - Add Redis to the application using a [Recipe]({{< ref "guides/recipes/overview" >}}) . | |
| - Adding a Redis Cache to your app definition, leveraging [Recipes]({{< ref "guides/recipes/overview" >}}) for the underlying infrastructure. |
Co-authored-by: Aaron Crawfis <[email protected]> Signed-off-by: Omer Bensaadon <[email protected]>
Co-authored-by: Aaron Crawfis <[email protected]> Signed-off-by: Omer Bensaadon <[email protected]>
Co-authored-by: Aaron Crawfis <[email protected]> Signed-off-by: Omer Bensaadon <[email protected]>
omerbensaadon
commented
Jan 4, 2024
omerbensaadon
commented
Jan 4, 2024
Signed-off-by: Omer Bensaadon <[email protected]>
AaronCrawfis
approved these changes
Jan 4, 2024
Reshrahim
added a commit
that referenced
this pull request
Jan 18, 2024
* Uninstall docs Signed-off-by: Reshma Abdul Rahim <[email protected]> * Fix ref Signed-off-by: Reshma Abdul Rahim <[email protected]> * Apply suggestions from code review Co-authored-by: Aaron Crawfis <[email protected]> Signed-off-by: Reshma Abdul Rahim <[email protected]> * Very small updates to Getting Started (#1015) * Update index.md small updates for clarity Signed-off-by: Omer Bensaadon <[email protected]> * Update docs/content/getting-started/index.md Co-authored-by: Aaron Crawfis <[email protected]> Signed-off-by: Omer Bensaadon <[email protected]> * Update docs/content/getting-started/index.md Co-authored-by: Aaron Crawfis <[email protected]> Signed-off-by: Omer Bensaadon <[email protected]> * Update docs/content/getting-started/index.md Co-authored-by: Aaron Crawfis <[email protected]> Signed-off-by: Omer Bensaadon <[email protected]> * Update docs/content/getting-started/index.md Signed-off-by: Omer Bensaadon <[email protected]> --------- Signed-off-by: Omer Bensaadon <[email protected]> Co-authored-by: Aaron Crawfis <[email protected]> * Update docs/content/guides/operations/kubernetes/kubernetes-uninstall/index.md Signed-off-by: Reshma Abdul Rahim <[email protected]> * Merge v0.29 Signed-off-by: Reshma Abdul Rahim <[email protected]> * Update docs/content/getting-started/index.md Signed-off-by: Reshma Abdul Rahim <[email protected]> * fix ref Signed-off-by: Reshma Abdul Rahim <[email protected]> * Fix ref Signed-off-by: Reshma Abdul Rahim <[email protected]> --------- Signed-off-by: Reshma Abdul Rahim <[email protected]> Signed-off-by: Reshma Abdul Rahim <[email protected]> Signed-off-by: Omer Bensaadon <[email protected]> Co-authored-by: Aaron Crawfis <[email protected]> Co-authored-by: Omer Bensaadon <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
small updates for clarity
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
Just made a few small changes for clarity as I was going through the Getting Started guide, hopefully these are well-received and thank you in advance for your review!
Issue reference