Address feedback from Under the Xray session #602

Reshrahim · 2023-06-02T20:18:15Z

Thank you for helping make the Radius documentation better!

Please follow this checklist before submitting:

Read the contribution guide
Commands include options for Linux, MacOS, and Windows within codetabs
New file and folder names are globally unique
Page references use shortcodes instead of markdown or URL links
Images use HTML style and have alternative text
Places where multiple code/command options are given have codetabs

In addition, please fill out the following to help reviewers understand this pull request:

Description

Addresses #586

Auto-generated description

`🤖 Generated by Copilot at 7692f3e`

Summary

🚀📝🔖

This pull request enhances the getting started documentation for Radius by adding a new option to use Codespaces for launching a containerized environment, and by adding markers to the app-with-redis-snippets.bicep file to facilitate code copying.

If you want to try Radius with ease
You can use Codespaces to launch k3d
Just follow the docs and the pics
And add your database connection tricks
To the app-with-redis-snippets.bicep

Walkthrough

Add Codespaces option to launch a pre-configured container with Radius installation on a k3d cluster (link)
Adjust instructions and notes for users who choose Codespaces option, such as skipping Radius CLI installation, getting demo app url from ports tab, and using different commands to run the application (link, link, link, link, link)
Fix typo and update marker in app-with-redis-snippets.bicep file to point to the entire container definition (link, link, link)
Update screenshot of demo container to show connection information for Redis and the TODO List tab (link)

Issue reference

github-actions · 2023-06-02T20:22:19Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-602.westus2.azurestaticapps.net

github-actions · 2023-06-02T20:22:38Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-602.westus2.azurestaticapps.net

github-actions · 2023-06-02T20:23:55Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-602.westus2.azurestaticapps.net

github-actions · 2023-06-02T20:27:19Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-602.westus2.azurestaticapps.net

docs/content/getting-started/first-app/_index.md

willtsai · 2023-06-05T18:31:20Z

docs/content/getting-started/first-app/_index.md

@@ -104,7 +120,7 @@ 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

-Access the application by opening [http://localhost:3000](http://localhost:3000) in a browser:
+Access the application by opening [http://localhost:3000](http://localhost:3000) in a browser. If you are using codespaces, you can get the demo app url from the ports tab in VSCode.


I remember having trouble looking for the port tab to get the remote localhost url. not sure if there's anything we can do to make this more clear?

Co-authored-by: jasonviviano <[email protected]>

Co-authored-by: Will <[email protected]>

github-actions · 2023-06-08T13:43:59Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-602.westus2.azurestaticapps.net

github-actions · 2023-06-08T14:02:57Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-602.westus2.azurestaticapps.net

github-actions · 2023-07-06T14:53:43Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-602.westus2.azurestaticapps.net
Password: Radiu$1234

github-actions · 2023-07-06T14:55:05Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-602.westus2.azurestaticapps.net
Password: Radiu$1234

github-actions · 2023-08-07T18:22:53Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-602.westus2.azurestaticapps.net
Password: Radiu$1234

… info before proceeding to copy code or run cmds Signed-off-by: Will Tsai <[email protected]>

github-actions · 2023-08-07T18:49:53Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-602.westus2.azurestaticapps.net
Password: Radiu$1234

AaronCrawfis · 2023-08-09T15:51:26Z

docs/content/getting-started/first-app/_index.md

+{{< tabs "Codespaces" "Kubernetes Cluster" >}}
+
+{{% codetab %}}
+Use [Codespaces](https://github.com/features/codespaces) to launch a pre-configured container with Radius installation on a k3d cluster


I still don't think we should put Codespaces as the first option. There's a 75% chance a reader will get a "404 not found" error when they click the button, and then when they hit that they'll then need to apply for GitHub access, which may take up to a couple hours. When users drop into the first app experience we don't want them to click a button and then have to wait before they can proceed.

I think we should 100% make it the primary experience once we go public, but we're not ready yet.

AaronCrawfis · 2023-08-09T15:51:47Z

docs/content/getting-started/first-app/_index.md

+
+{{% codetab %}}
+
+> *If you don't have a preferred way to create Kubernetes clusters, you could try using [k3d](https://k3d.io/), which runs a minimal Kubernetes distribution in Docker.*


I like this note

AaronCrawfis · 2023-08-09T15:53:45Z

docs/content/getting-started/first-app/_index.md

@@ -92,7 +108,7 @@ In addition to starting Radius services in your Kubernetes cluster, this initial

 ## 4. Run the app

-Use the `rad run` command to run the app in your environment:
+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. If you are using codespaces, you can get the demo app url from the ports tab in VSCode.


Once we add Codespaces support we should find a better way to handle opening the app instead of saying "from the ports tab".

github-actions · 2023-08-10T18:18:35Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-602.westus2.azurestaticapps.net
Password: Radiu$1234

github-actions · 2023-08-10T18:24:20Z

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-602.westus2.azurestaticapps.net
Password: Radiu$1234

Reshrahim · 2023-08-10T18:33:38Z

Closing this in favor of #680 to merge changes directly to v0.23

Adress feedback from Under the Xray session with a customer

7692f3e

Reshrahim requested a review from a team as a code owner June 2, 2023 20:18

Reshrahim and others added 2 commits June 2, 2023 16:18

fix typo

2351fb9

Merge branch 'v0.21' into reshma/firstapp

eacf83b

Fix spelling

3c9247f

Reshrahim linked an issue Jun 2, 2023 that may be closed by this pull request

Add more clear instructions on first-app page #586

Closed

jasonviviano reviewed Jun 5, 2023

View reviewed changes

docs/content/getting-started/first-app/_index.md Outdated Show resolved Hide resolved

willtsai reviewed Jun 5, 2023

View reviewed changes

Reshrahim and others added 4 commits June 8, 2023 08:38

Update docs/content/getting-started/first-app/_index.md

33e75e5

Co-authored-by: jasonviviano <[email protected]>

Update docs/content/getting-started/first-app/_index.md

eb6bd16

Co-authored-by: Will <[email protected]>

Update docs/content/getting-started/first-app/_index.md

d69d85f

Co-authored-by: Will <[email protected]>

Merge branch 'v0.21' into reshma/firstapp

1b5b3f7

Add todo image

3f5b6cb

Reshrahim changed the base branch from v0.21 to edge June 26, 2023 18:09

AaronCrawfis added the do-not-merge Do not merge this PR label Jun 26, 2023

AaronCrawfis added 2 commits July 6, 2023 07:48

Merge branch 'edge' into reshma/firstapp

694f9e5

Merge branch 'edge' into reshma/firstapp

e7ca216

Reshrahim removed the do-not-merge Do not merge this PR label Aug 7, 2023

Merge branch 'edge' into reshma/firstapp

f18efc3

moved the order within a few steps to ensure user reads all pertinent…

949168c

… info before proceeding to copy code or run cmds Signed-off-by: Will Tsai <[email protected]>

Reshrahim requested review from willtsai and jasonviviano August 7, 2023 23:08

willtsai previously approved these changes Aug 8, 2023

View reviewed changes

AaronCrawfis suggested changes Aug 9, 2023

View reviewed changes

Merge branch 'edge' into reshma/firstapp

0aa95b7

Remove codespaces content

b2a78d1

Reshrahim dismissed willtsai’s stale review via b2a78d1 August 10, 2023 18:20

Reshrahim changed the base branch from edge to v0.23 August 10, 2023 18:23

Reshrahim changed the base branch from v0.23 to edge August 10, 2023 18:23

Reshrahim closed this Aug 10, 2023

Reshrahim deleted the reshma/firstapp branch August 23, 2023 14:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Address feedback from Under the Xray session #602

Address feedback from Under the Xray session #602

Reshrahim commented Jun 2, 2023 •

edited by ghost

Loading

github-actions bot commented Jun 2, 2023

github-actions bot commented Jun 2, 2023

github-actions bot commented Jun 2, 2023

github-actions bot commented Jun 2, 2023

willtsai Jun 5, 2023

github-actions bot commented Jun 8, 2023

github-actions bot commented Jun 8, 2023

github-actions bot commented Jul 6, 2023 •

edited

Loading

github-actions bot commented Jul 6, 2023 •

edited

Loading

github-actions bot commented Aug 7, 2023 •

edited

Loading

github-actions bot commented Aug 7, 2023 •

edited

Loading

AaronCrawfis Aug 9, 2023

AaronCrawfis Aug 9, 2023

AaronCrawfis Aug 9, 2023

github-actions bot commented Aug 10, 2023 •

edited

Loading

github-actions bot commented Aug 10, 2023 •

edited

Loading

Reshrahim commented Aug 10, 2023


		{{% codetab %}}

		> If you don't have a preferred way to create Kubernetes clusters, you could try using [k3d](https://k3d.io/), which runs a minimal Kubernetes distribution in Docker.

Address feedback from Under the Xray session #602

Address feedback from Under the Xray session #602

Conversation

Reshrahim commented Jun 2, 2023 • edited by ghost Loading

Description

Auto-generated description

🤖 Generated by Copilot at 7692f3e

Summary

Walkthrough

Issue reference

github-actions bot commented Jun 2, 2023

github-actions bot commented Jun 2, 2023

github-actions bot commented Jun 2, 2023

github-actions bot commented Jun 2, 2023

willtsai Jun 5, 2023

Choose a reason for hiding this comment

github-actions bot commented Jun 8, 2023

github-actions bot commented Jun 8, 2023

github-actions bot commented Jul 6, 2023 • edited Loading

github-actions bot commented Jul 6, 2023 • edited Loading

github-actions bot commented Aug 7, 2023 • edited Loading

github-actions bot commented Aug 7, 2023 • edited Loading

AaronCrawfis Aug 9, 2023

Choose a reason for hiding this comment

AaronCrawfis Aug 9, 2023

Choose a reason for hiding this comment

AaronCrawfis Aug 9, 2023

Choose a reason for hiding this comment

github-actions bot commented Aug 10, 2023 • edited Loading

github-actions bot commented Aug 10, 2023 • edited Loading

Reshrahim commented Aug 10, 2023

Reshrahim commented Jun 2, 2023 •

edited by ghost

Loading

`🤖 Generated by Copilot at 7692f3e`

github-actions bot commented Jul 6, 2023 •

edited

Loading

github-actions bot commented Jul 6, 2023 •

edited

Loading

github-actions bot commented Aug 7, 2023 •

edited

Loading

github-actions bot commented Aug 7, 2023 •

edited

Loading

github-actions bot commented Aug 10, 2023 •

edited

Loading

github-actions bot commented Aug 10, 2023 •

edited

Loading