notifications-engine icon indicating copy to clipboard operation
notifications-engine copied to clipboard

docs: explicit when key is dynamic in services

Open Sayrus opened this issue 3 years ago • 2 comments

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: https://github.com/argoproj/argo-cd/pull/10589

Sayrus avatar Sep 14 '22 13:09 Sayrus

Codecov Report

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

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.

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

codecov[bot] avatar Sep 14 '22 13:09 codecov[bot]

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.

kostis-codefresh avatar Nov 29 '22 09:11 kostis-codefresh