Add complete documentation about flowdock notification

See #511

Add complete documentation about flowdock notification
See #511
Cyril Mougel
1 parent e6b992d6
Showing 3 changed files with 29 additions and 0 deletions Show diff stats
README.md
docs/notifications/flowdock/flow_token_api.jpg
docs/notifications/flowdock/index.md
@@ -438,6 +438,14 @@ card_type = Defect, status = Open, priority = Essential
 * issue_type Issue type
 * issue_priority Priority
+Notification Service
+--------------------
+
+**Flowdock Notification**
+
+Allow notification to [Flowdock](https://www.flowdock.com/). See
+[complete documentation](docs/notifications/flowdock/index.md)
+
 What if Errbit has an error?
 ----------------------------
@@ -0,0 +1,21 @@
+# Flowdock
+
+The flowdock notification send to [flowdock](https://www.flowdock.com/).
+
+## Configuration
+
+### Api token
+
+You need define the API token.
+It is purposely called Flow API Token and not Flowdock API Token to make
+it more obvious for user which one of the two tokens we expect:
+
+![flow token](flow_token_api.png)
+
+### Sender ( not configure )
+
+If you noticed default Gravatar icon in your Flowdock notifications you
+may want to [add Errbit icon](http://gravatar.com) for email that is
+set in ERRBIT_EMAIL_FROM.
+You don't need to approve or authorize it on Flowdock because it is
+used only for an icon.
	@@ -438,6 +438,14 @@ card_type = Defect, status = Open, priority = Essential		@@ -438,6 +438,14 @@ card_type = Defect, status = Open, priority = Essential
438	* issue_type Issue type	438	* issue_type Issue type
439	* issue_priority Priority	439	* issue_priority Priority
440		440
		441	+Notification Service
		442	+--------------------
		443	+
		444	+Flowdock Notification
		445	+
		446	+Allow notification to [Flowdock](https://www.flowdock.com/). See
		447	+[complete documentation](docs/notifications/flowdock/index.md)
		448	+
441		449
442	What if Errbit has an error?	450	What if Errbit has an error?
443	----------------------------	451	----------------------------
@@ -0,0 +1,21 @@		@@ -0,0 +1,21 @@
	1	+# Flowdock
	2	+
	3	+The flowdock notification send to [flowdock](https://www.flowdock.com/).
	4	+
	5	+## Configuration
	6	+
	7	+### Api token
	8	+
	9	+You need define the API token.
	10	+It is purposely called Flow API Token and not Flowdock API Token to make
	11	+it more obvious for user which one of the two tokens we expect:
	12	+
	13	+![flow token](flow_token_api.png)
	14	+
	15	+### Sender ( not configure )
	16	+
	17	+If you noticed default Gravatar icon in your Flowdock notifications you
	18	+may want to [add Errbit icon](http://gravatar.com) for email that is
	19	+set in ERRBIT_EMAIL_FROM.
	20	+You don't need to approve or authorize it on Flowdock because it is
	21	+used only for an icon.