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.

Sign up for GitHub

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

Jump to bottom

Address feedback from usability studies #680

Merged
merged 5 commits into from
Aug 14, 2023
Merged

Address feedback from usability studies #680

merged 5 commits into from
Aug 14, 2023

Conversation

Reshrahim
Copy link
Contributor

@Reshrahim Reshrahim commented Aug 10, 2023 •
edited by ghost
Loading

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

This PR addresses some feedback from usability studies #586

Auto-generated description

🤖 Generated by Copilot at ee9d024

Summary

📝🖼️💬

Improved the getting-started tutorial for creating and running a simple app with Project Radius. Added comments to app-with-redis-snippets.bicep and updated screenshots and instructions in _index.md.

To create an app with Project Radius
You need some instructions and guidance
So we added some comments
To the app.bicep contents
And improved the screenshots for vividness

Walkthrough

  • Polite the suggestion to use k3d for creating Kubernetes clusters (link)
  • Clarify the command and the URL to run and access the app (link, link)
  • Add comments to mark the code snippets for the container definition in app-with-redis-snippets.bicep (link, link)
  • Update the instructions for editing the app.bicep file with the code snippets and the container definition (link)
  • Simplify the instruction to run the updated app and open the browser (link)
  • Resize and add screenshots of the demo container and the todolist app (link)

Issue reference

#586

@Reshrahim Reshrahim requested a review from a team as a code owner August 10, 2023 18:32
@Reshrahim Reshrahim mentioned this pull request Aug 10, 2023
Closed
6 tasks
@github-actions
Copy link

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

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

1 similar comment
@github-actions
Copy link

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

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

@Reshrahim Reshrahim requested a review from willtsai August 11, 2023 13:54
@github-actions
Copy link

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

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

AaronCrawfis
AaronCrawfis reviewed Aug 12, 2023
View reviewed changes
docs/content/getting-started/first-app/_index.md Outdated Show resolved Hide resolved
docs/content/getting-started/first-app/_index.md
{{< rad file="snippets/app-with-redis-snippets.bicep" embed=true marker="//CONNECTION" >}}

The code you just added creates a connection between the container and the database. Based on this connection, Radius will define environment variables in the container that tell the container how to connect. You will view these in the next step.
{{< rad file="snippets/app-with-redis-snippets.bicep" embed=true marker="//CONTAINER" >}}
Copy link
Contributor

Choose a reason for hiding this comment

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

Now that we're showing the entire container do we also then need to show the entire app again?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah, good question. I think it would still help the users to validate the final bicep after additions.

@github-actions
Copy link

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

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

@github-actions
Copy link

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

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

@willtsai willtsai merged commit c2d4f0f into v0.23 Aug 14, 2023
@willtsai willtsai deleted the reabdul/firstapp branch August 14, 2023 18:18
@AaronCrawfis AaronCrawfis mentioned this pull request Sep 18, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AaronCrawfis AaronCrawfis AaronCrawfis approved these changes

@willtsai willtsai willtsai approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Reshrahim @willtsai @AaronCrawfis