radius-project / radius-project/docs
Suggestion/Request: more detailed information on authoring recipes
Nobody has claimed this yet.
- Dominant language
- Bicep
- Stars
- 26
- Forks
- 52
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 3
Description
What content needs to be created or modified?
We recently had a question on discord on authoring recipes for EC2 resource. We provided the contributor information on current samples of aws resource recipes and our documentation on authoring recipes and our current set of resource types returned by output resources.
Describe the solution you'd like
While the information provided is good, perhaps it would be good to provide more detailed information in our docs:
- one thought is to provide link to aws-bicep-types, so contributor can see that EC2 is a non-idempotent resource and we cannot author bicep recipes today. (correct me if that is wrong). We can still author Terraform recipes for EC2 but I am not seeing detailed instructions in our docs.
- In addition to samples/examples in current docs, it may be good to point contributors to, say a step by step example of determining input properties/associated/dependant resources and output resources when authoring Bicep and Terraform recipes.
Where should the new material be placed?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the existing guide at guides/recipes/howto-author-recipes/ and review its current samples, the linked aws-bicep-types supported-resources page, and the Terraform recipe information. Done means the guide explains EC2's Bicep limitation, links contributors to relevant resource support, and includes a step-by-step example for identifying inputs, dependencies, and outputs in Bicep and Terraform recipes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, terraform
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100