Add recipes contribution guides #63

Reshrahim · 2024-02-22T22:34:18Z

Fixes #54

AaronCrawfis

This is AWESOME!! Couple small formatting things but overall looks great!

docs/contributing/contributing-recipes.md

Signed-off-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com> Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

…project#60) * Adding tags parameters with radapp defaults to Azure Recipes Signed-off-by: Will Velida <willvelida@hotmail.co.uk> * Add radius-specific tags with optional tag parameters. null checking on application context in tag Signed-off-by: Will Velida <willvelida@hotmail.co.uk> * Adding hyphen character in radiusTags object Signed-off-by: Will Velida <willvelida@hotmail.co.uk> --------- Signed-off-by: Will Velida <willvelida@hotmail.co.uk> Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com> Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

README.md

aws/README.MD

docs/contributing/contributing-recipes.md

Co-authored-by: Karishma Chawla <kachawla@microsoft.com> Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com>

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

rynowak · 2024-02-26T19:27:15Z

README.md

-| [`aws/rediscaches`](/aws/rediscaches.bicep) | `Applications.Datastores/redisCaches` | An AWS MemoryDB resource with a configurable size and SKU. | `ghcr.io/radius-project/recipes/aws/rediscaches:TAG` |
+  - [Local Dev](/local-dev)
+  - [Azure](/azure)
+  - [AWS](/aws) 


Can we say more here? I'd like to say more about the background of how we're organizing these. If I want to contribute something, how can I figured out where it fits?

added some details on the structure of the folder.

rynowak · 2024-02-26T20:12:26Z

docs/contributing/contributing-recipes.md

+    For Bicep, Recipes leverage [Bicep registries](https://learn.microsoft.com/azure/azure-resource-manager/bicep/private-module-registry) for template storage. Once you've authored a Recipe, you can publish it to your preferred OCI-compliant registry with [`rad bicep publish`](https://docs.radapp.io/reference/cli/rad_bicep_publish/).:
+
+    ```bash
+    rad bicep publish --file myrecipe.bicep --target br:ghcr.io/USERNAME/recipes/myrecipe:1.1.0


This requires the user to login to GHCR first. Can we less specific with the example?

I think we should point that the user needs to login with docker login or similar. We've gotten a few bugs reports where the user is confused about this.

rynowak · 2024-02-26T20:19:22Z

docs/contributing/contributing-recipes.md

+    1. If the recipe is for local dev, add the recipe to the `local-dev` directory
+    1. If the recipe is for Azure, add the recipe to the `azure` directory
+    1. If the recipe is for AWS, add the recipe to the `aws` directory
+    1. If its a terraform recipe, create a directory name `<resourcetype>` under the relevant environment and add the recipe (e.g. `azure/redis/main.tf`) 


I'd suggest moving the description of "repo structure" elsewhere. This is really important info, but it's going to be hard to maintain as part of the insturctions for seting a PR.

Moved the repo structure to top level readme.md and hyperlinked here. Let me know if thats better

rynowak · 2024-02-26T20:19:52Z

azure/rediscaches.bicep

+  'radapp.io-application': context.application == null ? '' : context.application.id
+  'radapp.io-resource': context.resource.id
+}
+


Should this pattern be documented somewhere?

added this to the README in /azure directory

rynowak

This is overall looking really good. I left a few minor comments.

kachawla

Looks good overall, pending few comments from Ryan.

Thanks for adding this!

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

rynowak

Great!

Reshrahim requested a review from a team as a code owner February 22, 2024 22:34

AaronCrawfis reviewed Feb 23, 2024

View reviewed changes

docs/contributing/contributing-recipes.md Outdated Show resolved Hide resolved

docs/contributing/contributing-recipes.md Outdated Show resolved Hide resolved

AaronCrawfis approved these changes Feb 23, 2024

View reviewed changes

AaronCrawfis and others added 17 commits February 23, 2024 14:07

Fix container name (radius-project#58)

a8688d8

Signed-off-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com> Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Add contribution guides

f17aeac

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Add contribution link

212a18b

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Add contribution link

db03a55

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Add links to contribution guides to code and PR

33f86b3

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Rename contribution folder

35b2682

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Add links to contribution guides to code and PR

1630671

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Add testing steps

c3cee52

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Add testing steps

64e21c8

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

close bicep code snippet

6c6c4dc

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Delete .DS_Store

c58bece

Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Address feedback

d47207c

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Update docs/contributing/contributing-recipes.md

0d56f54

Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com> Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Address feedback

48aee83

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Update publish in test workflow to exclude readme file)

ef50556

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Empty-Commit

8cbb91a

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Reshrahim force-pushed the main branch from 5b0bb5f to 8cbb91a Compare February 23, 2024 19:07

kachawla reviewed Feb 26, 2024

View reviewed changes

Reshrahim and others added 3 commits February 26, 2024 11:46

Update aws/README.MD

3a74109

Co-authored-by: Karishma Chawla <kachawla@microsoft.com> Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com>

Apply suggestions from code review

bf440ae

Co-authored-by: Karishma Chawla <kachawla@microsoft.com> Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com>

Address feedback

57cfbe2

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

rynowak reviewed Feb 26, 2024

View reviewed changes

kachawla approved these changes Feb 26, 2024

View reviewed changes

Reshrahim added 5 commits February 26, 2024 17:20

Address feedback

88b096b

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Address feedback

04a99f7

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Address feedback

a8f8913

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Add hyperlink

91fdac3

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

Add hyperlink

88c3579

Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>

rynowak approved these changes Feb 27, 2024

View reviewed changes

kachawla merged commit 17f2799 into radius-project:main Feb 27, 2024
2 checks passed

Reshrahim mentioned this pull request Sep 27, 2024

REQUEST: New membership for reshrahim radius-project/community#53

Open

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add recipes contribution guides #63

Add recipes contribution guides #63

Reshrahim commented Feb 22, 2024

AaronCrawfis left a comment

rynowak Feb 26, 2024

Reshrahim Feb 26, 2024 •

edited

Loading

rynowak Feb 26, 2024

rynowak Feb 26, 2024

Reshrahim Feb 26, 2024

rynowak Feb 26, 2024

Reshrahim Feb 26, 2024

rynowak left a comment

kachawla left a comment

rynowak left a comment

Add recipes contribution guides #63

Add recipes contribution guides #63

Conversation

Reshrahim commented Feb 22, 2024

AaronCrawfis left a comment

Choose a reason for hiding this comment

rynowak Feb 26, 2024

Choose a reason for hiding this comment

Reshrahim Feb 26, 2024 • edited Loading

Choose a reason for hiding this comment

rynowak Feb 26, 2024

Choose a reason for hiding this comment

rynowak Feb 26, 2024

Choose a reason for hiding this comment

Reshrahim Feb 26, 2024

Choose a reason for hiding this comment

rynowak Feb 26, 2024

Choose a reason for hiding this comment

Reshrahim Feb 26, 2024

Choose a reason for hiding this comment

rynowak left a comment

Choose a reason for hiding this comment

kachawla left a comment

Choose a reason for hiding this comment

rynowak left a comment

Choose a reason for hiding this comment

Reshrahim Feb 26, 2024 •

edited

Loading