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.

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

Very small updates to Getting Started #1015

Merged
merged 5 commits into from
Jan 4, 2024
Merged
Changes from 4 commits
Commits
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
18 changes: 7 additions & 11 deletions docs/content/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Copy link
Author

Choose a reason for hiding this comment

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

feels more natural to put the link after the command is run, I was left sort of looking for it


```bash
rad run app.bicep
Expand All @@ -89,25 +89,21 @@ This command:
- Creates a port-forward from localhost to port 3000 inside the container so you can navigate to the app's frontend UI
- Streams container logs to your terminal

In your browser you should see the demo app:
Once the sample application is running, you can access it by opening [http://localhost:3000](http://localhost:3000) in a browser:

{{< image src="demo-screenshot.png" alt="Screenshot of the demo container" width=600px >}}
<br /><br />

Congrats! You're running your first Radius app. When you're ready to move on to the next step, use <kbd>CTRL</kbd>+ <kbd>C</kbd> to exit the command.
Congrats, you're running your first Radius app! When you're ready to move on to the next step, use <kbd>CTRL</kbd>+ <kbd>C</kbd> to terminate the application.
omerbensaadon marked this conversation as resolved.
Show resolved Hide resolved

## 5. Add Database

This step will add a database (Redis Cache) to the application.
In this step you will add a database (Redis Cache) to the application by:

You can create a Redis Cache using [Recipes]({{< ref "guides/recipes/overview" >}}) provided by Radius. The Radius community provides Recipes for running commonly used application dependencies, including Redis.
- Add Redis to the application using a [Recipe]({{< ref "guides/recipes/overview" >}}) .
Copy link
Author

Choose a reason for hiding this comment

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

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?

Copy link
Contributor

Choose a reason for hiding this comment

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

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.

omerbensaadon marked this conversation as resolved.
Show resolved Hide resolved
omerbensaadon marked this conversation as resolved.
Show resolved Hide resolved
- Adding a connection from the `demo` container to the Redis cache, which automatically sets environment variables with connection information.

In this step you will:

- Add Redis to the application using a Recipe.
- Connect to Redis from the `demo` container using environment variables that Radius automatically sets.

Open `app.bicep` in your editor and get ready to edit the file.
Begin by opening `app.bicep` in your editor and get ready to edit the file.

First add some new code to `app.bicep` by pasting in the content below at the end of the file. This code creates a Redis Cache using a Radius Recipe:

Expand Down
Loading