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 output object name (value -> result) #658

Merged
merged 4 commits into from
Aug 11, 2023
Merged

Conversation

kachawla
Copy link
Contributor

@kachawla kachawla commented Jul 31, 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

Auto-generated description

🤖 Generated by Copilot at a4ea83e

Summary

📝🔄🚫

Update custom recipe documentation to improve output naming, resource linking, and validator warning handling. Clarify how to use result, values, and secrets in docs/content/operations/custom-recipes/index.md.

To write custom recipes with ease
Use result for outputs, please
And to link resources
Use values and secrets
But add a comment to appease

Walkthrough

  • Refactor output object name from values to result to improve clarity and consistency (link)
  • Add values and secrets properties to output object to demonstrate linking resources (link)
  • Suppress warning for outputting secrets with a comment (link)

Issue reference

@kachawla kachawla requested a review from a team as a code owner July 31, 2023 22:30
@github-actions
Copy link

github-actions bot commented Aug 11, 2023

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

@AaronCrawfis AaronCrawfis merged commit 4d85c27 into v0.23 Aug 11, 2023
7 of 8 checks passed
@AaronCrawfis AaronCrawfis deleted the kachawla-bicep-outputs branch August 11, 2023 23:40
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.

3 participants