Skip to content

docs: explicit when key is dynamic in services#104

Open
Sayrus wants to merge 1 commit intoargoproj:masterfrom
Sayrus:update-documentation-from-slack-questions
Open

docs: explicit when key is dynamic in services#104
Sayrus wants to merge 1 commit intoargoproj:masterfrom
Sayrus:update-documentation-from-slack-questions

Conversation

@Sayrus
Copy link
Copy Markdown

@Sayrus Sayrus commented Sep 14, 2022

It isn't clear to all users that xxx - a map of the form key: value means that the user can specify their own key. This PR adds additional examples to help discern whether the key is statically defined by notifications-engine or defined by the end user.

This follows questions asked on #argo-cd-notifications

I also reflected this in argoproj/argo-cd: argoproj/argo-cd#10589

Signed-off-by: Mathis Raguin <mathis@cri.epita.fr>
@Sayrus Sayrus force-pushed the update-documentation-from-slack-questions branch from f5a2795 to 9fc466f Compare September 14, 2022 13:00
@codecov
Copy link
Copy Markdown

codecov Bot commented Sep 14, 2022

Codecov Report

Base: 49.21% // Head: 49.21% // No change to project coverage 👍

Coverage data is based on head (9fc466f) compared to base (4d8552b).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #104   +/-   ##
=======================================
  Coverage   49.21%   49.21%           
=======================================
  Files          31       31           
  Lines        1855     1855           
=======================================
  Hits          913      913           
  Misses        743      743           
  Partials      199      199           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@kostis-codefresh
Copy link
Copy Markdown
Member

Hello

Instead of changing the existing example, may I suggest you add a separate example that has multiple /spaces/channels/teams etc?

This way instead of having a single example that readers are expected to take and then comment/uncomment stuff, they simply can take the example that matches their case directly.

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