chore: pull services documentation from github.com/argoproj/notifications-engine (#261)

Author: Alexander Matyushentsev

Makefile

@@ -11,10 +11,15 @@ test:
 lint:
 	golangci-lint run
 
+.PHONY: docs
+docs:
+	rm -rf vendor && go mod vendor && mkdir -p docs/services
+	cp -r vendor/github.com/argoproj/notifications-engine/docs/services/* docs/services && rm docs/services/*.go && rm -rf vendor
+	go run github.com/argoproj-labs/argocd-notifications/hack/gen docs
+
 .PHONY: catalog
 catalog:
 	go run github.com/argoproj-labs/argocd-notifications/hack/gen catalog
-	go run github.com/argoproj-labs/argocd-notifications/hack/gen docs
 
 .PHONY: manifests
 manifests:
@@ -26,7 +31,7 @@ tools:
 	go install github.com/golang/mock/[email protected]
 
 .PHONY: generate
-generate: manifests catalog tools
+generate: manifests docs catalog tools
 	go generate ./...
 
 .PHONY: build

docs/services/email.md

@@ -18,7 +18,7 @@ The following snippet contains sample Gmail service configuration:
 apiVersion: v1
 kind: ConfigMap
 metadata:
-  name: argocd-notifications-cm
+  name: <config-map-name>
 data:
   service.email.gmail: |
     username: $email-username
@@ -34,7 +34,7 @@ Without authentication:
 apiVersion: v1
 kind: ConfigMap
 metadata:
-  name: argocd-notifications-cm
+  name: <config-map-name>
 data:
   service.email.example: |
     host: smtp.example.com
@@ -50,7 +50,7 @@ Notification templates support specifying subject for email notifications:
 apiVersion: v1
 kind: ConfigMap
 metadata:
-  name: argocd-notifications-cm
+  name: <config-map-name>
 data:
   template.app-sync-succeeded: |
     email:

docs/services/github.md

@@ -24,7 +24,7 @@ in `argocd-notifications-cm` ConfigMap
 apiVersion: v1
 kind: ConfigMap
 metadata:
-  name: argocd-notifications-cm
+  name: <config-map-name>
 data:
   service.github: |
     appID: <app-id>
@@ -36,7 +36,7 @@ data:
 apiVersion: v1
 kind: Secret
 metadata:
-  name: argocd-notifications-secret
+  name: <secret-name>
 stringData:
   github-privateKey: |
     -----BEGIN RSA PRIVATE KEY-----

docs/services/grafana.md

@@ -15,7 +15,7 @@ To be able to create Grafana annotation with argocd-notifications you have to cr
 apiVersion: v1
 kind: ConfigMap
 metadata:
-  name: argocd-notifications-cm
+  name: <config-map-name>
 data:
   service.grafana: |
     apiUrl: https://grafana.example.com/api
@@ -26,7 +26,7 @@ data:
 apiVersion: v1
 kind: Secret
 metadata:
-  name: argocd-notifications-secret
+  name: <secret-name>
 stringData:
   grafana-api-key: api-key
 ```

docs/services/mattermost.md

@@ -19,7 +19,7 @@ in `argocd-notifications-cm` ConfigMap
 apiVersion: v1
 kind: ConfigMap
 metadata:
-  name: argocd-notifications-cm
+  name: <config-map-name>
 data:
   service.mattermost: |
     apiURL: <api-url>
@@ -30,7 +30,7 @@ data:
 apiVersion: v1
 kind: Secret
 metadata:
-  name: argocd-notifications-secret
+  name: <secret-name>
 stringData:
   mattermost-token: token
 ```

docs/services/opsgenie.md

@@ -19,7 +19,7 @@ To be able to send notifications with argocd-notifications you have to create an
 apiVersion: v1
 kind: ConfigMap
 metadata:
-  name: argocd-notifications-cm
+  name: <config-map-name>
 data:
   service.opsgenie: |
     apiUrl: <api-url>

docs/services/overview.md

@@ -12,9 +12,9 @@ The `slack` indicates that service sends slack notification; name is missing and
 
 ## Sensitive Data
 
-Sensitive data like authentication tokens should be stored in `argocd-notifications-secret` Secret and can be referenced in
+Sensitive data like authentication tokens should be stored in `<secret-name>` Secret and can be referenced in
 service configuration using `$<secret-key>` format. For example `$slack-token` referencing value of key `slack-token` in
-`argocd-notifications-secret` Secret.
+`<secret-name>` Secret.
 
 ## Custom Names
 

docs/services/slack.md

@@ -19,7 +19,7 @@
 apiVersion: v1
 kind: Secret
 metadata:
-  name: argocd-notifications-secret
+  name: <secret-name>
 stringData:
   slack-token: <auth-token>
 ```
@@ -30,7 +30,7 @@ stringData:
 apiVersion: v1
 kind: ConfigMap
 metadata:
-  name: argocd-notifications-cm
+  name: <config-map-name>
 data:
   service.slack: |
     apiURL: <url>                 # optional URL, e.g. https://example.com/api

docs/services/teams.md

@@ -18,7 +18,7 @@ The Teams notification service send message notifications using Teams bot and re
 apiVersion: v1
 kind: ConfigMap
 metadata:
-  name: argocd-notifications-cm
+  name: <config-map-name>
 data:
   service.teams: |
     recipientUrls:
@@ -29,7 +29,7 @@ data:
 apiVersion: v1
 kind: Secret
 metadata:
-  name: argocd-notifications-secret
+  name: <secret-name>
 stringData:
   channel-teams-url: https://example.com
 ```

docs/services/telegram.md

@@ -1,14 +1,14 @@
 # Telegram
 
 1. Get an API token using [@Botfather](https://t.me/Botfather).
-2. Store token in `argocd_notifications-secret` Secret and configure telegram integration
-in `argocd-notifications-cm` ConfigMap:
+2. Store token in `<secret-name>` Secret and configure telegram integration
+in `<config-map-name>` ConfigMap:
 
 ```yaml
 apiVersion: v1
 kind: ConfigMap
 metadata:
-  name: argocd-notifications-cm
+  name: <config-map-name>
 data:
   service.telegram: |
     token: $telegram-token