-
Notifications
You must be signed in to change notification settings - Fork 43
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
Restructure docs #690
Restructure docs #690
Conversation
Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-690.westus2.azurestaticapps.net |
Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-690.westus2.azurestaticapps.net |
Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-690.westus2.azurestaticapps.net |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One minor change suggested. Reviewed "First app" in detail and the other pages/menu bar at a higher level. New structure looks great and provides a great framework for us to continue building upon!
Co-authored-by: Will <[email protected]>
Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-690.westus2.azurestaticapps.net |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall the new structure is great!!. Suggested some changes on removing "how-to" in the link title and making the title task oriented.
docs/content/guides/author-apps/aws/howto-aws-resources/index.md
Outdated
Show resolved
Hide resolved
docs/content/guides/author-apps/azure/howto-azure-resources/index.md
Outdated
Show resolved
Hide resolved
docs/content/guides/author-apps/containers/howto-environment-variables/index.md
Outdated
Show resolved
Hide resolved
docs/content/guides/operations/providers/howto-cloud-providers/index.md
Outdated
Show resolved
Hide resolved
docs/content/guides/operations/workspaces/howto-workspaces/index.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Reshma Abdul Rahim <[email protected]>
…docs into aacrawfi/docs-v2
title: "Radius application" | ||
linkTitle: "Application" | ||
description: "Learn how to model your application and its services in Radius" | ||
title: "Overview: Radius applications" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think for the title
leaving the name for all the sections that are accessed through diving into specific topics should probably stay as just "Overview" versus "Overview: Topic" makes more sense as the user should know by the time they click on Applications that the Overview page found here is for Applications.
Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-690.westus2.azurestaticapps.net |
Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-690.westus2.azurestaticapps.net |
@@ -0,0 +1,71 @@ | |||
--- | |||
type: docs | |||
title: "How-To: Install the Radius-Bicep VSCode extension" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we move this content inside Installation page? This feels out of place under authoring
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Discussed in PM meeting, will pickup in PR to templatize this information and place it in both places
Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-690.westus2.azurestaticapps.net |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approving the overall structure changes, we can open additional PRs to make changes to titles, ordering, etc.
This PR restructures the docs based on the new diataxis framework.
Content updates were minimal, only changing page content to make it fit the new framework.
There are many guides to be written so spots in the docs might be a little sparse, but we'll fill them in.