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

Remove quickstarts from docs #683

Closed
wants to merge 4 commits into from
Closed

Conversation

AaronCrawfis
Copy link
Contributor

This PR removes quickstarts, migrating the existing guides into how-to guides and tutorials.

Note that tutorials still need to be documented and contribution guides need to be written, as part of a follow-up PR.

@AaronCrawfis AaronCrawfis requested a review from a team as a code owner August 14, 2023 17:02
@github-actions
Copy link

github-actions bot commented Aug 14, 2023

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

@github-actions
Copy link

github-actions bot commented Aug 14, 2023

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

@github-actions
Copy link

github-actions bot commented Aug 14, 2023

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

Copy link
Contributor

@willtsai willtsai left a comment

Choose a reason for hiding this comment

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

some general feedback:

  1. I feel that the reference apps section should be nested under tutorials given the similarity in the intent of the content
  2. I'm torn on whether the languages/bicep section should be nested under getting started as it's a pretty nuanced topic, perhaps it fits better under concepts?


- How to use Radius to deploy a Dapr microservices sample application for an online shop
- How [Dapr and Radius]({{< ref dapr-resources >}}) seamlessly work together

For more details on the app and access to the source code, visit the `quickstarts/dapr` directory in the [samples repo](https://github.com/project-radius/samples). _For access to the project-radius GitHub org, please complete and submit [this form](https://aka.ms/ProjectRadius/GitHubAccess)._
For more details on the app and access to the source code, visit the `tutorials/dapr` directory in the [samples repo](https://github.com/project-radius/samples). _For access to the project-radius GitHub org, please complete and submit [this form](https://aka.ms/ProjectRadius/GitHubAccess)._
Copy link
Contributor

Choose a reason for hiding this comment

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

Does the samples/quickstarts/... need to be renamed as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes the container image names will need to be updated, but that will require a PR into the samples repo and redoing the CI/CD systems. Opened an Issue to track as part of a follow up PR: radius-project/samples#462

Copy link
Contributor

Choose a reason for hiding this comment

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

I think this file name is causing issues with how the side bar renders and resulting in the S3 page being blank:

image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's an existing issue that exists already on docs.radapp.dev. I can get that fixed when I go in to remove the reference apps in a follow up PR

@AaronCrawfis
Copy link
Contributor Author

I feel that the reference apps section should be nested under tutorials given the similarity in the intent of the content

Reference apps are also going to be removed in an upcoming PR, with eShop becoming a tutorial. Still working out where to put the others (or remove them). But that will be a follow up PR.

I'm torn on whether the languages/bicep section should be nested under getting started as it's a pretty nuanced topic, perhaps it fits better under concepts?

The Bicep page will be converted into a how-to guide (or overview) under deploying apps in a follow up PR. Wanted to focus on just removing quickstarts in this PR.

@github-actions
Copy link

❌ Spellcheck Failed

There are spelling errors in your PR. Visit the workflow output to see what words are failing.

Adding new words

If you are adding a new custom word refer to the docs guide

@AaronCrawfis
Copy link
Contributor Author

Closing in favor of #690

@AaronCrawfis AaronCrawfis deleted the aacrawfi/remove-quickstarts branch October 23, 2023 23:42
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.

2 participants