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

Fix rad_group_switch synopsis text #1206

Conversation

brooke-hamilton
Copy link
Contributor

Fix the synopsis text formatting from a code block to a regular text block.

  • 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

The rad group switch page currently uses code formatting for the synopsis text. This PR fixes the formatting.

image

Issue reference

Fixes: N/A

Fix the synopsis text formatting from a code block to a regular text block.

Signed-off-by: Brooke Hamilton <[email protected]>
@Reshrahim
Copy link
Contributor

@brooke-hamilton - The CLI docs are autogenerated from Radius repository. Can you close this and make changes to the file in radius repository

@Reshrahim Reshrahim closed this Sep 13, 2024
ytimocin added a commit to radius-project/radius that referenced this pull request Nov 13, 2024
Fix the synopsis text formatting from a code block to a regular text
block.

- [x] [Read the contribution
guide](https://docs.radapp.io/community/contributing/docs/)
- [x] Commands include options for Linux, MacOS, and Windows within
codetabs
- [x] New file and folder names are globally unique
- [x] Page references use shortcodes instead of markdown or URL links
- [x] Images use HTML style and have alternative text
- [x] 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

The rad [group switch
page](https://docs.radapp.io/reference/cli/rad_group_switch/) currently
uses code formatting for the synopsis text. This PR fixes the
formatting.


![image](https://github.com/user-attachments/assets/5f456e77-0304-4368-a72c-06256ddc3ab8)


## Issue reference

Fixes: N/A

## Other
@Reshrahim thank you for reviewing the other PR on this and pointing me
to the right way to fix:
radius-project/docs#1206

---------

Signed-off-by: Brooke Hamilton <[email protected]>
Co-authored-by: Ryan Nowak <[email protected]>
Co-authored-by: Yetkin Timocin <[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