Fixed whitespace and markdown consistency in reference docs #978
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Emanuel Palm <[email protected]>
Signed-off-by: Emanuel Palm <[email protected]>
PalmEmanuel
changed the title
|
I was asked to split #967 in different more logical pieces. I understand this is still a pretty big PR, but it's mainly whitespace fixes for the CLI reference docs. |
AaronCrawfis
suggested changes
Nov 27, 2023
…0.27-reference-whitespace
Signed-off-by: Emanuel Palm <[email protected]>
…manuel/docs into v0.27-reference-whitespace
PalmEmanuel
changed the title
AaronCrawfis
approved these changes
Nov 27, 2023
Reshrahim
added a commit
that referenced
this pull request
Dec 7, 2023
* Add docs on simulated environments (#942) * Add simulated reference doc Signed-off-by: Aaron Crawfis <[email protected]> * Add simulated environments to overview Signed-off-by: Aaron Crawfis <[email protected]> * Update docs/content/reference/resource-schema/core-schema/environment-schema/index.md Co-authored-by: Reshma Abdul Rahim <[email protected]> Signed-off-by: Aaron Crawfis <[email protected]> --------- Signed-off-by: Aaron Crawfis <[email protected]> Signed-off-by: Aaron Crawfis <[email protected]> Co-authored-by: Reshma Abdul Rahim <[email protected]> * Removing duplicate codespace section (#944) Signed-off-by: jasonviviano <[email protected]> * Update wording of "operators" (#928) * Update wording of "operators" Signed-off-by: Aaron Crawfis <[email protected]> * Update to "IT operators" Signed-off-by: Aaron Crawfis <[email protected]> * Add IT Signed-off-by: Aaron Crawfis <[email protected]> * Update docs/content/guides/recipes/overview/index.md Signed-off-by: Will <[email protected]> --------- Signed-off-by: Aaron Crawfis <[email protected]> Signed-off-by: Will <[email protected]> Co-authored-by: Will <[email protected]> * docs: the output is not correct (#969) Signed-off-by: lbzs <[email protected]> * Added Azure resource page (#975) * Added Azure resource page Signed-off-by: jasonviviano <[email protected]> * Fixed spellcheck Signed-off-by: jasonviviano <[email protected]> --------- Signed-off-by: jasonviviano <[email protected]> * Remove "webapp" from the deployment output (#973) Signed-off-by: Reshma Abdul Rahim <[email protected]> Co-authored-by: Aaron Crawfis <[email protected]> * Add a page on publicly available Radius artifacts (#947) Signed-off-by: Reshma Abdul Rahim <[email protected]> * Localize Azure resource page (#981) Signed-off-by: jasonviviano <[email protected]> * Add news article Signed-off-by: Aaron Crawfis <[email protected]> * Spellcheck Signed-off-by: Aaron Crawfis <[email protected]> * Whitespace removal and formatting (#979) * whitespace and markdown formatting Signed-off-by: Emanuel Palm <[email protected]> * Markdown numbered lists changed to 1 Signed-off-by: Emanuel Palm <[email protected]> --------- Signed-off-by: Emanuel Palm <[email protected]> Co-authored-by: Aaron Crawfis <[email protected]> * Markdown numbering consistency and updated contribution guide (#983) * explanation of numbered lists for markdown in contribution guide * numbered lists changed to 1 for all markdown Signed-off-by: Emanuel Palm <[email protected]> --------- Signed-off-by: Emanuel Palm <[email protected]> Signed-off-by: Aaron Crawfis <[email protected]> Co-authored-by: Aaron Crawfis <[email protected]> * Fixed whitespace and markdown consistency in reference docs (#978) * fixed whitespace in CLI reference Signed-off-by: Emanuel Palm <[email protected]> * consistency in bullet point markdown Signed-off-by: Emanuel Palm <[email protected]> * restore CLI docs * restore CLI docs Signed-off-by: Emanuel Palm <[email protected]> --------- Signed-off-by: Emanuel Palm <[email protected]> Co-authored-by: Aaron Crawfis <[email protected]> * Remove customer label (#982) Signed-off-by: Aaron Crawfis <[email protected]> * Add Aspire comparison (#984) * Add Aspire comparison This PR adds a comparison between Radius and .NET Aspire * Spellcheck Signed-off-by: Aaron Crawfis <[email protected]> * Apply suggestions from code review Co-authored-by: Ryan Nowak <[email protected]> Signed-off-by: Aaron Crawfis <[email protected]> * Apply feedback Signed-off-by: Aaron Crawfis <[email protected]> --------- Signed-off-by: Aaron Crawfis <[email protected]> Co-authored-by: Ryan Nowak <[email protected]> * Definitions, typos and clarifications in docs (#985) * key vault bicep template and comment not matching schema values Signed-off-by: Emanuel Palm <[email protected]> * clarify RP as resource provider Signed-off-by: Emanuel Palm <[email protected]> * typo Signed-off-by: Emanuel Palm <[email protected]> * open source changed to open-source according to MS style guide Signed-off-by: Emanuel Palm <[email protected]> * workspace examples clarified with different names Signed-off-by: Emanuel Palm <[email protected]> * moved paragraph to Bicep section in FAQ Signed-off-by: Emanuel Palm <[email protected]> * fixed missing word and quote Signed-off-by: Emanuel Palm <[email protected]> * CRD definition, removed duplicate term in word list Signed-off-by: Emanuel Palm <[email protected]> --------- Signed-off-by: Emanuel Palm <[email protected]> Co-authored-by: Aaron Crawfis <[email protected]> * Deleting page content from `_index.md` files and renaming others to `index.md` (#946) * Documentation for Supported Terraform Recipe Sources (#935) * Adding a column to the Recipe overview page to indicate supported storages. Signed-off-by: jasonviviano <[email protected]> * Update docs/content/guides/recipes/overview/index.md Co-authored-by: Aaron Crawfis <[email protected]> Signed-off-by: jasonviviano <[email protected]> --------- Signed-off-by: jasonviviano <[email protected]> Co-authored-by: Aaron Crawfis <[email protected]> * Removed content from pages that users shouldn't be able to access and renamed to correct syntax some files `index.md` that were not named correctly. Signed-off-by: jasonviviano <[email protected]> * Added an overview page to resource schema Signed-off-by: jasonviviano <[email protected]> * Removed unnecessary pages from PR. Signed-off-by: jasonviviano <[email protected]> --------- Signed-off-by: jasonviviano <[email protected]> Signed-off-by: Aaron Crawfis <[email protected]> Co-authored-by: Aaron Crawfis <[email protected]> * Add extender docs (#933) * Add overview Signed-off-by: Aaron Crawfis <[email protected]> * Add how-to guide Signed-off-by: Aaron Crawfis <[email protected]> * Apply suggestions from code review Co-authored-by: Will <[email protected]> Signed-off-by: Aaron Crawfis <[email protected]> * Add additional info on extenders Signed-off-by: Aaron Crawfis <[email protected]> * Spelling Signed-off-by: Aaron Crawfis <[email protected]> * Fix quote Signed-off-by: Aaron Crawfis <[email protected]> --------- Signed-off-by: Aaron Crawfis <[email protected]> Co-authored-by: Will <[email protected]> * removing duplicate --------- Signed-off-by: Aaron Crawfis <[email protected]> Signed-off-by: Aaron Crawfis <[email protected]> Signed-off-by: jasonviviano <[email protected]> Signed-off-by: Will <[email protected]> Signed-off-by: lbzs <[email protected]> Signed-off-by: Reshma Abdul Rahim <[email protected]> Signed-off-by: Reshma Abdul Rahim <[email protected]> Signed-off-by: Emanuel Palm <[email protected]> Co-authored-by: Aaron Crawfis <[email protected]> Co-authored-by: jasonviviano <[email protected]> Co-authored-by: Will <[email protected]> Co-authored-by: lbzs <[email protected]> Co-authored-by: Emanuel Palm <[email protected]> Co-authored-by: Ryan Nowak <[email protected]>
Reshrahim
added a commit
that referenced
this pull request
Dec 7, 2023
* Add docs on simulated environments (#942) * Add simulated reference doc * Add simulated environments to overview * Update docs/content/reference/resource-schema/core-schema/environment-schema/index.md --------- * Removing duplicate codespace section (#944) * Update wording of "operators" (#928) * Update wording of "operators" * Update to "IT operators" * Add IT * Update docs/content/guides/recipes/overview/index.md --------- * docs: the output is not correct (#969) * Added Azure resource page (#975) * Added Azure resource page * Fixed spellcheck --------- * Remove "webapp" from the deployment output (#973) * Add a page on publicly available Radius artifacts (#947) * Localize Azure resource page (#981) * Add news article * Spellcheck * Whitespace removal and formatting (#979) * whitespace and markdown formatting * Markdown numbered lists changed to 1 --------- * Markdown numbering consistency and updated contribution guide (#983) * explanation of numbered lists for markdown in contribution guide * numbered lists changed to 1 for all markdown --------- * Fixed whitespace and markdown consistency in reference docs (#978) * fixed whitespace in CLI reference * consistency in bullet point markdown * restore CLI docs * restore CLI docs --------- * Remove customer label (#982) * Add Aspire comparison (#984) * Add Aspire comparison This PR adds a comparison between Radius and .NET Aspire * Spellcheck * Apply suggestions from code review * Apply feedback --------- * Definitions, typos and clarifications in docs (#985) * key vault bicep template and comment not matching schema values * clarify RP as resource provider * typo * open source changed to open-source according to MS style guide * workspace examples clarified with different names * moved paragraph to Bicep section in FAQ * fixed missing word and quote * CRD definition, removed duplicate term in word list --------- * Deleting page content from `_index.md` files and renaming others to `index.md` (#946) * Documentation for Supported Terraform Recipe Sources (#935) * Adding a column to the Recipe overview page to indicate supported storages. * Update docs/content/guides/recipes/overview/index.md --------- * Removed content from pages that users shouldn't be able to access and renamed to correct syntax some files `index.md` that were not named correctly. * Added an overview page to resource schema * Removed unnecessary pages from PR. --------- * Add extender docs (#933) * Add overview * Add how-to guide * Apply suggestions from code review * Add additional info on extenders * Spelling * Fix quote --------- * removing duplicate --------- Signed-off-by: Aaron Crawfis <[email protected]> Signed-off-by: Aaron Crawfis <[email protected]> Signed-off-by: jasonviviano <[email protected]> Signed-off-by: Will <[email protected]> Signed-off-by: lbzs <[email protected]> Signed-off-by: Reshma Abdul Rahim <[email protected]> Signed-off-by: Reshma Abdul Rahim <[email protected]> Signed-off-by: Emanuel Palm <[email protected]> Co-authored-by: Aaron Crawfis <[email protected]> Co-authored-by: jasonviviano <[email protected]> Co-authored-by: Will <[email protected]> Co-authored-by: lbzs <[email protected]> Co-authored-by: Emanuel Palm <[email protected]> Co-authored-by: Ryan Nowak <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Removed unnecessary whitespace and adjusted formatting of all CLI Reference pages for markdown consistency.
Auto-generated description
🤖[deprecated] Generated by Copilot at 7bb3e4b
Summary
📝🎨🔧
This pull request improves the documentation of various
radcommands and resource policies by fixing formatting, casing, indentation, and readability issues. It replaces tabs with spaces, removes empty code blocks, adds blank lines and links, and capitalizes PowerShell in several files underdocs/content/reference.Walkthrough
rad_bicep_publish.md(link, link)rad_completion_powershell.mdandrad_completion.md(link, link)rad_completion.md(link)rad_credential_register.md(link)