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

Deleting page content from _index.md files and renaming others to index.md #946

Merged
merged 7 commits into from
Dec 2, 2023

Conversation

jasonviviano
Copy link
Contributor

@jasonviviano jasonviviano commented Nov 14, 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

Fixes data shown to users and naming conventions.

Auto-generated description

🤖 Generated by Copilot at da19fe0

Summary

🔥🚫🔄

This pull request removes unnecessary or outdated content from the reference section of the Radius documentation, and renames some files to follow a consistent naming convention. It also fixes some rendering issues caused by the redoc shortcode, and prepares the resource schema reference section for a major update.

redoc shortcode
gone from index pages now
cleaner rendering

Walkthrough

  • Remove redoc shortcodes from API reference index pages to avoid rendering issues and duplication of content (link, link, link)
  • Remove irrelevant or redundant headings from reference index pages to improve consistency and clarity (link, link, link, link)
  • Remove outdated and irrelevant resource schema reference section and prepare for replacement by new Bicep templates and parameters documentation (link)
  • Rename files with _index.md suffix to index.md to follow Hugo conventions and avoid potential conflicts (link, link, link, link, link, link, link, link)

Issue reference

#939

jasonviviano and others added 3 commits November 13, 2023 11:24
* 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]>
Signed-off-by: Aaron Crawfis <[email protected]>
… renamed to correct syntax some files `index.md` that were not named correctly.

Signed-off-by: jasonviviano <[email protected]>
docs/config.toml Outdated Show resolved Hide resolved
docs/layouts/partials/hooks/body-end.html Outdated Show resolved Hide resolved
Copy link

Azure Static Web Apps: Your stage site is ready! Visit it here: https://calm-bush-0cc2a4f1e-946.westus2.3.azurestaticapps.net

@AaronCrawfis AaronCrawfis merged commit 1a342e8 into v0.27 Dec 2, 2023
9 checks passed
@AaronCrawfis AaronCrawfis deleted the jasonviviano/clearing-section-pages branch December 2, 2023 00:14
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants