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

docs: Incomplete documentation of Email service #203

Open
lindhe opened this issue Jul 25, 2023 · 2 comments
Open

docs: Incomplete documentation of Email service #203

lindhe opened this issue Jul 25, 2023 · 2 comments

Comments

@lindhe
Copy link
Contributor

lindhe commented Jul 25, 2023

Currently, the documentation for the Email service does not have an example of how to configure credentials in the argocd-notifications-secret Secret object. Adding that would be a huge benefit for the reader.

@lindhe lindhe changed the title docs: Missing example of Secrets configuration for Email service docs: Incomplete documentation of Email service Jul 25, 2023
@lindhe
Copy link
Contributor Author

lindhe commented Jul 25, 2023

I just realized it's missing another major thing: an example of how to subscribe.

Especially since the service is (without any comment) defined as service.email.gmail, it's very confusing as to how one subscribes to events. Which one of these would be the right annotation to use?

  • notifications.argoproj.io/subscribe.<trigger>.email: <recipient>
  • notifications.argoproj.io/subscribe.<trigger>.email.gmail: <recipient>
  • notifications.argoproj.io/subscribe.<trigger>.gmail: <recipient>

Could I drop the .gmail suffix and just have it be service.email, similar to the examples for Slack?

@lindhe
Copy link
Contributor Author

lindhe commented Jul 26, 2023

Could I drop the .gmail suffix and just have it be service.email, similar to the examples for Slack?

Seems so. ¯\_(ツ)_/¯

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

No branches or pull requests

1 participant