shorten the dapr quickstart by willtsai · Pull Request #636 · radius-project/docs

willtsai · 2023-06-28T23:56:59Z

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

Consolidated the five pages of Dapr quickstart into a single page to follow the new shortened format.

Auto-generated description

`🤖 Generated by Copilot at 1d549ac`

Summary

📝🧩🔎

This pull request refactors and simplifies the bicep snippet files and the documentation for the Dapr quickstart. It removes unnecessary or outdated files and sections, and adds comment markers and placeholders to guide the user through the tutorial. It also updates the overview page to link to the source code of the app.

Dapr quickstart, unleash the power
Comment markers and placeholders, guide the way
Remove the clutter, show the essence
Snippets of code, shape the future

Walkthrough

Simplify and clarify the overview section of the quickstart-dapr page and add a link to the samples repo (link)
Add comment markers to the snippet files to indicate where the app, backend, stateStore, backendRoute, frontend, frontendRoute, and gateway resources start and end (link, link, link, link, link, link, link, link, link, link)
Remove the provides property from the daprSidecar extension in the backend resource, as it is not needed for the connection to the stateStore resource (link, link, link)
Remove the comment marker for the Redis Kubernetes resources, as it is not relevant for the snippet files (link, link, link)
Remove the description annotations from the environment and namespace parameters in the final snippet file, as they are not needed (link)
Change the name of the port in the backend container from web to orders, to match the name of the port in the backendRoute resource (link)
Remove the redundant resource definitions from the final snippet file, as they are already defined in the previous snippet files (link)
Add the complete application definition to the final snippet file, to show all the resources together (link)
Delete the files that are no longer needed for the quickstart-dapr, as they are replaced by the snippet files (link, link, link, link, link, link, link, link, link, link, link)

Issue reference

Fixes: #592 and #524

Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>

…radius/docs into willtsai/update-dapr-qs

Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>

github-actions · 2023-07-06T23:53:10Z

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

willtsai · 2023-07-07T18:21:27Z

change the Radius Environment reference page after #644 gets merged

github-actions · 2023-07-07T18:24:17Z

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

AaronCrawfis

Looking good! Since we're already using rad run we can probably ditch the httproute and the gateway.

We can also use the new Dapr State Store dev recipe and simplify even further.

And we should think about if we want to show a Radius connection between frontend and backend directly, or omit it and wait for the new shorthand notation. Concerned because the Radius app graph wouldn't show a relationship between frontend and backend.

…ets/dapr.bicep Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

github-actions · 2023-07-07T21:24:18Z

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

github-actions · 2023-07-07T21:25:09Z

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

github-actions · 2023-07-07T21:26:58Z

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

Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>

github-actions · 2023-07-07T21:31:03Z

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

github-actions · 2023-07-10T19:12:34Z

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

github-actions · 2023-07-10T23:26:14Z

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

Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>

github-actions · 2023-07-18T00:17:30Z

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

AaronCrawfis

Overall looking good. I wonder if we can "prove" the value of Dapr a little more though steps to show that the Dapr component has been created, and that the backend container is up and running. I worry that rad resource list may not be enough to show value.

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

github-actions · 2023-07-21T18:13:50Z

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

Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>

github-actions · 2023-07-21T23:35:23Z

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

github-actions · 2023-07-21T23:37:36Z

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

github-actions · 2023-07-21T23:43:14Z

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

AaronCrawfis

Couple small comments but overall looks great

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>

github-actions · 2023-07-27T00:15:49Z

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

shorten the dapr quickstart

1d549ac

Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>

willtsai requested a review from a team as a code owner June 28, 2023 23:56

willtsai marked this pull request as draft June 28, 2023 23:57

willtsai mentioned this pull request Jun 29, 2023

add background info for dapr quickstart radius-project/samples#381

Merged

willtsai added 5 commits June 29, 2023 13:55

more dapr quickstart edits

a00ec51

Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>

v0.22 upmerge

ab17d66

Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>

more dapr quickstart edits

aabefc6

Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>

more dapr quickstart edits

da3c3f4

Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>

some clean up

7c88a76

Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>

AaronCrawfis suggested changes Jun 30, 2023

View reviewed changes

willtsai added 3 commits July 6, 2023 11:53

Merge branch 'v0.22' into willtsai/update-dapr-qs

362ba13

Merge branch 'willtsai/update-dapr-qs' of https://github.com/project-…

8924473

…radius/docs into willtsai/update-dapr-qs

address Aaron's feedback, minus converting to recipes

9d379f5

Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>

Merge branch 'v0.22' into willtsai/update-dapr-qs

f709f5b

AaronCrawfis suggested changes Jul 7, 2023

View reviewed changes

willtsai and others added 5 commits July 7, 2023 14:20

Update docs/content/getting-started/quickstarts/quickstart-dapr/snipp…

e3db03e

…ets/dapr.bicep Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

Update docs/content/getting-started/quickstarts/quickstart-dapr/index.md

bdd790d

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

Update docs/content/getting-started/quickstarts/quickstart-dapr/index.md

f652ce8

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

Apply suggestions from code review

8047471

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

Merge branch 'v0.22' into willtsai/update-dapr-qs

54e58d5

address Aaron's feedback

54b2cb7

Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>

willtsai changed the base branch from v0.22 to edge July 7, 2023 21:32

willtsai changed the base branch from edge to v0.22 July 7, 2023 21:33

willtsai marked this pull request as ready for review July 10, 2023 19:09

willtsai mentioned this pull request Jul 10, 2023

The connections part in the Dapr bicep files may need an update #524

Closed

Merge branch 'edge' into willtsai/update-dapr-qs

1dc4359

app works now

67eee98

Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>

AaronCrawfis suggested changes Jul 18, 2023

View reviewed changes

willtsai requested a review from AaronCrawfis July 21, 2023 18:03

commit Aaron's suggestions

86d5e66

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

willtsai added 2 commits July 21, 2023 16:32

incorporate Aaron's suggestions on confirming dapr

f6dcae9

Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>

remove kubectl content

9c9df81

Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>

Merge branch 'edge' into willtsai/update-dapr-qs

5de8af5

AaronCrawfis previously approved these changes Jul 24, 2023

View reviewed changes

willtsai dismissed AaronCrawfis’s stale review via ca3febc July 26, 2023 16:43

Apply suggestions from Aaron

ca3febc

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>

willtsai requested a review from AaronCrawfis July 26, 2023 16:44

AaronCrawfis previously approved these changes Jul 26, 2023

View reviewed changes

fix recipes page link

ad08d82

Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>

willtsai dismissed AaronCrawfis’s stale review via ad08d82 July 27, 2023 00:12

willtsai requested a review from AaronCrawfis July 27, 2023 00:12

AaronCrawfis approved these changes Jul 27, 2023

View reviewed changes

willtsai merged commit 57b7e56 into edge Jul 27, 2023

willtsai deleted the willtsai/update-dapr-qs branch July 27, 2023 16:18

willtsai mentioned this pull request Jul 27, 2023

Update Dapr quickstart to follow new format #592

Closed

Conversation

willtsai commented Jun 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Auto-generated description

🤖 Generated by Copilot at 1d549ac

Summary

Walkthrough

Issue reference

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Jul 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

willtsai commented Jul 7, 2023

Uh oh!

github-actions Bot commented Jul 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AaronCrawfis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Jul 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jul 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jul 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jul 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jul 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jul 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jul 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AaronCrawfis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Jul 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jul 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jul 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jul 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AaronCrawfis left a comment

Choose a reason for hiding this comment

Uh oh!

willtsai commented Jun 28, 2023 •

edited

Loading

`🤖 Generated by Copilot at 1d549ac`

github-actions Bot commented Jul 6, 2023 •

edited

Loading

github-actions Bot commented Jul 7, 2023 •

edited

Loading

github-actions Bot commented Jul 7, 2023 •

edited

Loading

github-actions Bot commented Jul 7, 2023 •

edited

Loading

github-actions Bot commented Jul 7, 2023 •

edited

Loading

github-actions Bot commented Jul 7, 2023 •

edited

Loading

github-actions Bot commented Jul 10, 2023 •

edited

Loading

github-actions Bot commented Jul 10, 2023 •

edited

Loading

github-actions Bot commented Jul 18, 2023 •

edited

Loading

github-actions Bot commented Jul 21, 2023 •

edited

Loading

github-actions Bot commented Jul 21, 2023 •

edited

Loading

github-actions Bot commented Jul 21, 2023 •

edited

Loading

github-actions Bot commented Jul 21, 2023 •

edited

Loading

github-actions Bot commented Jul 27, 2023 •

edited

Loading