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

Doc formatting for rad_group_switch synopsis text #7962

Merged
merged 5 commits into from
Nov 13, 2024

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

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]>
Copy link

codecov bot commented Sep 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.21%. Comparing base (1cb666c) to head (3d19a92).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7962   +/-   ##
=======================================
  Coverage   59.21%   59.21%           
=======================================
  Files         579      579           
  Lines       38697    38697           
=======================================
  Hits        22914    22914           
  Misses      14145    14145           
  Partials     1638     1638           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

nithyatsu
nithyatsu previously approved these changes Sep 24, 2024
@radius-functional-tests
Copy link

radius-functional-tests bot commented Sep 24, 2024

Radius functional test overview

🔍 Go to test action run

Name Value
Repository brooke-hamilton/radius
Commit ref a7e2e11
Unique ID funcde4b27d945
Image tag pr-funcde4b27d945
Click here to see the list of tools in the current test run
  • gotestsum 1.12.0
  • KinD: v0.20.0
  • Dapr: 1.12.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.3.0
  • Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-funcde4b27d945
  • Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
  • applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-funcde4b27d945
  • controller test image location: ghcr.io/radius-project/dev/controller:pr-funcde4b27d945
  • ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-funcde4b27d945
  • deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting corerp-cloud functional tests...
⌛ Starting datastoresrp-cloud functional tests...
⌛ Starting ucp-cloud functional tests...
✅ datastoresrp-cloud functional tests succeeded
✅ ucp-cloud functional tests succeeded
✅ corerp-cloud functional tests succeeded

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should also be tested locally to see how it looks.

@radius-functional-tests
Copy link

radius-functional-tests bot commented Oct 24, 2024

Radius functional test overview

🔍 Go to test action run

Name Value
Repository brooke-hamilton/radius
Commit ref 424877e
Unique ID func7f9b32a3eb
Image tag pr-func7f9b32a3eb
Click here to see the list of tools in the current test run
  • gotestsum 1.12.0
  • KinD: v0.20.0
  • Dapr: 1.12.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.3.0
  • Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-func7f9b32a3eb
  • Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
  • applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-func7f9b32a3eb
  • controller test image location: ghcr.io/radius-project/dev/controller:pr-func7f9b32a3eb
  • ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-func7f9b32a3eb
  • deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting ucp-cloud functional tests...
⌛ Starting corerp-cloud functional tests...
✅ ucp-cloud functional tests succeeded
✅ corerp-cloud functional tests succeeded

@radius-functional-tests
Copy link

radius-functional-tests bot commented Nov 13, 2024

Radius functional test overview

🔍 Go to test action run

Name Value
Repository brooke-hamilton/radius
Commit ref 3d19a92
Unique ID func28f8a42ef4
Image tag pr-func28f8a42ef4
Click here to see the list of tools in the current test run
  • gotestsum 1.12.0
  • KinD: v0.20.0
  • Dapr: 1.12.0
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.3.0
  • Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-func28f8a42ef4
  • Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
  • applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-func28f8a42ef4
  • dynamic-rp test image location: ghcr.io/radius-project/dev/dynamic-rp:pr-func28f8a42ef4
  • controller test image location: ghcr.io/radius-project/dev/controller:pr-func28f8a42ef4
  • ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-func28f8a42ef4
  • deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting corerp-cloud functional tests...
⌛ Starting ucp-cloud functional tests...
✅ ucp-cloud functional tests succeeded
✅ corerp-cloud functional tests succeeded

@ytimocin ytimocin merged commit 125b9fd into radius-project:main Nov 13, 2024
29 checks passed
@brooke-hamilton brooke-hamilton deleted the group-create-doc-fix branch November 13, 2024 23:24
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.

5 participants