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

shorten the dapr quickstart #636

Merged
merged 28 commits into from
Jul 27, 2023
Merged

shorten the dapr quickstart #636

merged 28 commits into from
Jul 27, 2023

Conversation

willtsai
Copy link
Contributor

@willtsai willtsai commented Jun 28, 2023

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

@willtsai willtsai requested a review from a team as a code owner June 28, 2023 23:56
@willtsai willtsai marked this pull request as draft June 28, 2023 23:57
Signed-off-by: Will Tsai <[email protected]>
Signed-off-by: Will Tsai <[email protected]>
@github-actions
Copy link

github-actions bot commented Jul 6, 2023

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

@willtsai
Copy link
Contributor Author

willtsai commented Jul 7, 2023

change the Radius Environment reference page after #644 gets merged

@github-actions
Copy link

github-actions bot commented Jul 7, 2023

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

Copy link
Contributor

@AaronCrawfis AaronCrawfis left a comment

Choose a reason for hiding this comment

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

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.

@github-actions
Copy link

github-actions bot commented Jul 7, 2023

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

2 similar comments
@github-actions
Copy link

github-actions bot commented Jul 7, 2023

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
Copy link

github-actions bot commented Jul 7, 2023

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 <[email protected]>
@github-actions
Copy link

github-actions bot commented Jul 7, 2023

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

@willtsai willtsai changed the base branch from v0.22 to edge July 7, 2023 21:32
@willtsai willtsai changed the base branch from edge to v0.22 July 7, 2023 21:33
@willtsai willtsai marked this pull request as ready for review July 10, 2023 19:09
@github-actions
Copy link

github-actions bot commented Jul 10, 2023

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
Copy link

github-actions bot commented Jul 10, 2023

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 <[email protected]>
@github-actions
Copy link

github-actions bot commented Jul 18, 2023

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

Copy link
Contributor

@AaronCrawfis AaronCrawfis left a comment

Choose a reason for hiding this comment

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

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 <[email protected]>
@github-actions
Copy link

github-actions bot commented Jul 21, 2023

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
Copy link

github-actions bot commented Jul 21, 2023

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

1 similar comment
@github-actions
Copy link

github-actions bot commented Jul 21, 2023

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
Copy link

github-actions bot commented Jul 21, 2023

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

AaronCrawfis
AaronCrawfis previously approved these changes Jul 24, 2023
Copy link
Contributor

@AaronCrawfis AaronCrawfis left a comment

Choose a reason for hiding this comment

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

Couple small comments but overall looks great

Co-authored-by: Aaron Crawfis <[email protected]>
AaronCrawfis
AaronCrawfis previously approved these changes Jul 26, 2023
Signed-off-by: Will Tsai <[email protected]>
@github-actions
Copy link

github-actions bot commented Jul 27, 2023

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

@willtsai willtsai merged commit 57b7e56 into edge Jul 27, 2023
8 checks passed
@willtsai willtsai deleted the willtsai/update-dapr-qs branch July 27, 2023 16:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Dapr quickstart to follow new format
2 participants