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

Restructure docs #690

Merged
merged 16 commits into from
Aug 22, 2023
Merged

Restructure docs #690

merged 16 commits into from
Aug 22, 2023

Conversation

AaronCrawfis
Copy link
Contributor

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.

@AaronCrawfis AaronCrawfis requested a review from a team as a code owner August 18, 2023 23:46
@AaronCrawfis AaronCrawfis mentioned this pull request Aug 18, 2023
Closed
@github-actions
Copy link

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

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

@github-actions
Copy link

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

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

@github-actions
Copy link

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

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

willtsai
willtsai requested changes Aug 21, 2023
View reviewed changes
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.

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!

docs/content/getting-started/index.md Outdated Show resolved Hide resolved
@github-actions
Copy link

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

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

Reshrahim
Reshrahim requested changes Aug 22, 2023
View reviewed changes
Copy link
Contributor

@Reshrahim Reshrahim left a 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/community/contributing/contributing-docs/index.md Outdated Show resolved Hide resolved
docs/content/community/maintainers/docs-maintainers.md Outdated Show resolved Hide resolved
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/deploy-apps/howto-rad-cli/index.md Outdated Show resolved Hide resolved
docs/content/guides/operations/kubernetes/_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
docs/content/guides/recipes/howto-author-recipes/index.md Outdated Show resolved Hide resolved
@AaronCrawfis @Reshrahim
Apply suggestions from code review
025a3ec 
Co-authored-by: Reshma Abdul Rahim <[email protected]>
jasonviviano
jasonviviano reviewed Aug 22, 2023
View reviewed changes
docs/content/guides/author-apps/application/overview/index.md
title: "Radius application"
linkTitle: "Application"
description: "Learn how to model your application and its services in Radius"
title: "Overview: Radius applications"
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 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.

@github-actions
Copy link

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

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

@github-actions
Copy link

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

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

Reshrahim
Reshrahim previously requested changes Aug 22, 2023
View reviewed changes
docs/content/guides/author-apps/howto-vscode/index.md Show resolved Hide resolved
docs/content/guides/author-apps/howto-vscode/index.md
@@ -0,0 +1,71 @@
---
type: docs
title: "How-To: Install the Radius-Bicep VSCode extension"
Copy link
Contributor

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

Copy link
Contributor Author

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

willtsai
willtsai previously approved these changes Aug 22, 2023
View reviewed changes
@github-actions
Copy link

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

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

willtsai
willtsai approved these changes Aug 22, 2023
View reviewed changes
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.

Approving the overall structure changes, we can open additional PRs to make changes to titles, ordering, etc.

@AaronCrawfis AaronCrawfis dismissed Reshrahim’s stale review August 22, 2023 16:19

Discussed in the PM meeting

@AaronCrawfis AaronCrawfis merged commit 9c39e1f into edge Aug 22, 2023
8 checks passed
@AaronCrawfis AaronCrawfis deleted the aacrawfi/docs-v2 branch August 22, 2023 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jasonviviano jasonviviano jasonviviano left review comments

@willtsai willtsai willtsai approved these changes

@Reshrahim Reshrahim Awaiting requested review from Reshrahim

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

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