add teams docs

containrrr · Aug 10, 2020 · a9206f0 · a9206f0
1 parent bafc331
commit a9206f0
Show file tree

Hide file tree

Showing 9 changed files with 59 additions and 52 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -1,29 +1,17 @@
-<p align="center">
-    <a href="https://github.com/containrrr/shoutrrr"><img src="https://github.com/containrrr/shoutrrr/raw/gh-pages/shoutrrr.jpg" width="450" /></a>
-</p>
-<h1 align="center">
-    Shoutrrr
-</h1>
-<p align="center">
-    Notification library for gophers and their furry friends.
-    Heavily inspired by <a href="https://github.com/caronc/apprise">caronc/apprise</a>.
-</p>
-<p align="center">
-    <a href="https://app.codacy.com/app/containrrr/shoutrrr?utm_source=github.com&utm_medium=referral&utm_content=containrrr/shoutrrr&utm_campaign=Badge_Grade_Dashboard"><img
-          alt="codacy coverage"
-          src="https://img.shields.io/codacy/coverage/30ce077eecde418ca328f4f7868f70c8.svg?style=flat-square"
-        /></a>
-    <a href="https://circleci.com/gh/containrrr/shoutrrr"><img
-          alt="circleci"
-          src="https://img.shields.io/circleci/project/github/containrrr/shoutrrr/master.svg?style=flat-square"
-        /></a>
-    <a href="https://app.codacy.com/app/containrrr/shoutrrr?utm_source=github.com&utm_medium=referral&utm_content=containrrr/shoutrrr&utm_campaign=Badge_Grade_Dashboard"><img
- alt="codacy grade" src="https://img.shields.io/codacy/grade/30ce077eecde418ca328f4f7868f70c8/master.svg?style=flat-square" /></a>
-    <a href="https://github.com/containrrr/shoutrrr"><img alt="GitHub code size in bytes" src="https://img.shields.io/github/languages/code-size/containrrr/shoutrrr.svg?style=flat-square" /></a>
-    <a href="https://github.com/containrrr/shoutrrr/blob/master/LICENSE"><img alt="license" src="https://img.shields.io/github/license/containrrr/shoutrrr.svg?style=flat-square" /></a>
-    <a href="https://godoc.org/github.com/containrrr/shoutrrr"><img           src="https://godoc.org/github.com/containrrr/shoutrrr?status.svg" alt="GoDoc" /></a>
-</p>
+# Shoutrrr
+
+
+[![shoutrrr logo](https://github.com/containrrr/shoutrrr/raw/gh-pages/shoutrrr.jpg)](https://github.com/containrrr/shoutrrr)
+
+Notification library for gophers and their furry friends.
+Heavily inspired by <a href="https://github.com/caronc/apprise">caronc/apprise</a>.
+
+[![codacy coverage](https://img.shields.io/codacy/coverage/30ce077eecde418ca328f4f7868f70c8.svg?style=flat-square)](https://app.codacy.com/app/containrrr/shoutrrr?utm_source=github.com&utm_medium=referral&utm_content=containrrr/shoutrrr&utm_campaign=Badge_Grade_Dashboard)
+[![codacy grade](https://img.shields.io/codacy/grade/30ce077eecde418ca328f4f7868f70c8/master.svg?style=flat-square)](https://app.codacy.com/app/containrrr/shoutrrr?utm_source=github.com&utm_medium=referral&utm_content=containrrr/shoutrrr&utm_campaign=Badge_Grade_Dashboard)
+[![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/containrrr/shoutrrr.svg?style=flat-square)](https://github.com/containrrr/shoutrrr)
+[![license](https://img.shields.io/github/license/containrrr/shoutrrr.svg?style=flat-square)](https://github.com/containrrr/shoutrrr/blob/master/LICENSE)
+[![godoc](https://godoc.org/github.com/containrrr/shoutrrr?status.svg)](https://godoc.org/github.com/containrrr/shoutrrr)
 
 To make it easy and streamlined to consume shoutrrr regardless of the notification service you want to use,
 we've implemented a notification service url schema. To send notifications, instantiate the `ShoutrrrClient` using one of
-the service urls below.
+the service urls from the [overview](/services/overview).
diff --git a/docs/services/discord.md b/docs/services/discord.md
@@ -1,6 +1,6 @@
 # Discord
 
-## URL format
+## URL Format
 
 Your Discord Webhook-URL will look like this:
 > https://discordapp.com/api/webhooks/__`channel`__/__`token`__  

diff --git a/docs/services/hangouts.md b/docs/services/hangouts.md
@@ -1,6 +1,6 @@
 # Hangouts Chat
 
-## URL format
+## URL Format
 
 Your Hangouts Chat Incoming Webhook URL will look like this:
 

diff --git a/docs/services/mattermost.md b/docs/services/mattermost.md
@@ -1,6 +1,6 @@
 # MatterMost
 
-## URL format
+## URL Format
 
 ## Creating a Webhook in MatterMost
 

diff --git a/docs/services/overview.md b/docs/services/overview.md
@@ -2,18 +2,18 @@
 
 Click on the service for a more thorough explanation.
 
-| Service                                      | URL format   |
-| -------------------------------------------- | ------------ |
-| [Discord](/shoutrrr/services/discord)                 | *discord://__`token`__@__`channel`__* |
-| [Telegram](/shoutrrr/services/not-documented)         | *telegram://__`token`__@telegram?channels=__`channel-1`__[,__`channel-2`__,...]* |
-| [Pushover](/shoutrrr/services/pushover)               | *pushover://shoutrrr:__`apiToken`__@__`userKey`__/?devices=__`device1`__[,__`device2`__, ...]* |
-| [Slack](/shoutrrr/services/not-documented)            | *slack://[__`botname`__@]__`token-a`__/__`token-b`__/__`token-c`__* |
-| [Email](/shoutrrr/services/not-documented)            | *smtp://__`username`__:__`password`__@__`host`__:__`port`__/?fromAddress=__`fromAddress`__&toAddresses=__`recipient1`__[,__`recipient2`__,...]* |
-| [Microsoft Teams](/shoutrrr/services/not-documented)  | *teams://__`token-a`__/__`token-b`__/__`token-c`__* |
-| [Gotify](/shoutrrr/services/not-documented)           | *gotify://__`gotify-host`__/__`token`__* |
-| [Pushbullet](/shoutrrr/services/not-documented)       | *pushbullet://__`api-token`__[/__`device`__/#__`channel`__/__`email`__]* |
-| [IFTTT](/shoutrrr/services/not-documented)            | *ifttt://__`key`__/?events=__`event1`__[,__`event2`__,...]&value1=__`value1`__&value2=__`value2`__&value3=__`value3`__* |
-| [Mattermost](/shoutrrr/services/not-documented)       | *mattermost://[__`username`__@]__`mattermost-host`__/__`token`__[/__`channel`__]* |
-| [Hangouts Chat](/shoutrrr/services/hangouts)          | *hangouts://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz* |
-| [Zulip Chat](/shoutrrr/services/zulip)                | *zulip://__`bot-mail`__:__`bot-key`__@__`zulip-domain`__/?stream=__`name-or-id`__&topic=__`name`__* |
-| [Join](/shoutrrr/services/not-documented)             | *join://shoutrrr:__`api-key`__@join/?devices=__`device1`__[,__`device2`__, ...][&icon=__`icon`__][&title=__`title`__]* |
+| Service                           | URL format                                                                                                                                      |
+| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+| [Discord](./discord.md)           | *discord://__`token`__@__`channel`__*                                                                                                           |
+| [Telegram](./not-documented.md)   | *telegram://__`token`__@telegram?channels=__`channel-1`__[,__`channel-2`__,...]*                                                                |
+| [Pushover](./pushover.md)         | *pushover://shoutrrr:__`apiToken`__@__`userKey`__/?devices=__`device1`__[,__`device2`__, ...]*                                                  |
+| [Slack](./not-documented.md)      | *slack://[__`botname`__@]__`token-a`__/__`token-b`__/__`token-c`__*                                                                             |
+| [Email](./not-documented.md)      | *smtp://__`username`__:__`password`__@__`host`__:__`port`__/?fromAddress=__`fromAddress`__&toAddresses=__`recipient1`__[,__`recipient2`__,...]* |
+| [Microsoft Teams](./teams.md)     | *teams://__`token-a`__/__`token-b`__/__`token-c`__*                                                                                             |
+| [Gotify](./not-documented.md)     | *gotify://__`gotify-host`__/__`token`__*                                                                                                        |
+| [Pushbullet](./not-documented.md) | *pushbullet://__`api-token`__[/__`device`__/#__`channel`__/__`email`__]*                                                                        |
+| [IFTTT](./not-documented.md)      | *ifttt://__`key`__/?events=__`event1`__[,__`event2`__,...]&value1=__`value1`__&value2=__`value2`__&value3=__`value3`__*                         |
+| [Mattermost](./not-documented.md) | *mattermost://[__`username`__@]__`mattermost-host`__/__`token`__[/__`channel`__]*                                                               |
+| [Hangouts Chat](./hangouts.md)    | *hangouts://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz*                                                                       |
+| [Zulip Chat](./zulip.md)          | *zulip://__`bot-mail`__:__`bot-key`__@__`zulip-domain`__/?stream=__`name-or-id`__&topic=__`name`__*                                             |
+| [Join](./not-documented.md)       | *join://shoutrrr:__`api-key`__@join/?devices=__`device1`__[,__`device2`__, ...][&icon=__`icon`__][&title=__`title`__]*                          |
diff --git a/docs/services/pushover.md b/docs/services/pushover.md
@@ -1,6 +1,6 @@
 # Pushover
 
-## URL Reference
+## URL Format
 
 *pushover://shoutrrr:__`apiToken`__@__`userKey`__/?devices=__`device1`__[,__`device2`__, ...]*
 

diff --git a/docs/services/teams.md b/docs/services/teams.md
@@ -0,0 +1,18 @@
+# Teams
+
+## URL Format
+
+*teams://__`token-a`__/__`token-b`__/__`token-c`__*
+
+## Setting up a webhook
+
+To be able to use the Microsoft Teams notification service, you first need to set up a custom webhook.
+Instructions on how to do this can be found in [this guide](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/connectors-using#setting-up-a-custom-incoming-webhook)
+
+## Extracting the token
+
+The token is extracted from your webhook URL:
+
+```
+  https://outlook.office.com/webhook/{tokenA}/IncomingWebhook/{tokenB}/{tokenC}
+```
diff --git a/docs/services/zulip.md b/docs/services/zulip.md
@@ -1,6 +1,6 @@
 # Zulip Chat
 
-## URL format
+## URL Format
 
 The shoutrrr service URL should look like this:  
 > zulip://__`bot-mail`__:__`bot-key`__@__`zulip-domain`__/?stream=__`name-or-id`__&topic=__`name`__

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -11,17 +11,18 @@ theme:
 markdown_extensions:
   - toc:
       permalink: True
-      separator: "_"
+      separator: '_'
   - codehilite
 nav:
   - 'Home': 'index.md'
   - 'Getting started': 'getting-started.md'
+  - 'Overview': 'services/overview.md'
   - Services:
-    - Overview: 'services/overview.md'
-    - Discord: 'services/discord.md'
-    - Hangouts Chat: 'services/hangouts.md'
-    - Pushover: 'services/pushover.md'
-    - Zulip Chat: 'services/zulip.md'
+      - Discord: 'services/discord.md'
+      - Hangouts Chat: 'services/hangouts.md'
+      - Pushover: 'services/pushover.md'
+      - Teams: 'services/teams.md'
+      - Zulip Chat: 'services/zulip.md'
 
 plugins:
   - search