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

Move redundant installation content into shared folder #798

Merged
merged 2 commits into from
Oct 2, 2023

Conversation

Reshrahim
Copy link
Contributor

@Reshrahim Reshrahim commented Sep 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

This PR moves redundant installation content into a shared folder and reads from it wherever needed. Helps with easier maintenance to keep up with changes.

Auto-generated description

🤖 Generated by Copilot at d20ac36

Summary

🗂️📝🔄

This pull request refactors the installation instructions for the rad CLI, the VS Code extension, and the Radius control-plane by using a new read shortcode that reads the content from shared files in the shared-content directory. This improves the maintainability and consistency of the documentation.

read shortcode added
content from shared files used
autumn of repeats

Walkthrough

  • Add a new shortcode read that reads and renders the content of a file as markdown (link)
  • Add three shared files that contain the installation instructions for the rad CLI, the VS Code extension, and the Radius control-plane (link, link, link)
  • Replace the inline installation instructions with the read shortcode in the following pages: getting-started/index.md, guides/operations/kubernetes/kubernetes-upgrade/index.md, guides/tooling/rad-cli/howto-rad-cli/index.md, guides/tooling/vscode/howto-vscode-bicep/index.md, and installation/index.md (link, link, link, link, link)
  • Add a new mount point for the module in the config.toml file to access the shared-content directory (link)

Issue reference

@Reshrahim Reshrahim requested review from a team as code owners September 28, 2023 17:47
@github-actions
Copy link

github-actions bot commented Sep 28, 2023

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

1 similar comment
@github-actions
Copy link

github-actions bot commented Sep 28, 2023

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-798.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.

Love this! One note on shortcode usage

docs/layouts/shortcodes/read.html Show resolved Hide resolved
@Reshrahim Reshrahim merged commit e47f72d into edge Oct 2, 2023
8 of 9 checks passed
@Reshrahim Reshrahim deleted the reshma/sharedcode branch October 2, 2023 18:17
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