search

argoproj / argo-rollouts

Progressive Delivery for Kubernetes
https://argo-rollouts.readthedocs.io/
Apache License 2.0
2.59k stars 819 forks source link

Update Notification services docs #1680

Open RaviHari opened 2 years ago

RaviHari commented 2 years ago

Summary

Argo Rollout Notification services documentation uses app in the templates instead of rollouts as it might have been taken from argocd-notifications documentation. https://argoproj.github.io/argo-rollouts/generated/notification-services/email/ It would be good to update it with rollout templates in all the services documentaitons.

Message from the maintainers:

Impacted by this bug? Give it a 👍. We prioritize the issues with the most 👍.

meeech commented 1 year ago

To help anyone coming later - the bulk of the notif docs seem to be pulled in: https://github.com/argoproj/argo-rollouts/blob/master/hack/gen-docs/main.go#L28

meeech commented 1 year ago

Docs should give guidance to the namespace that the notifications-install.yaml should be installed to: same namespace as the controller

github-actions[bot] commented 1 year ago

This issue is stale because it has been open 60 days with no activity.

kzap commented 4 months ago

I was looking at this in my PR https://github.com/argoproj/argo-rollouts/pull/3384 but its hard to keep up to date with changes in the docs if they are specific to ArgoCD, I would prefer if the notifications-engine docs were project agnostic and each project would make their replacements

Although a string replacement is simple, entire examples may not be...