From 453365d0c2efc7e9ae605dc19d6d9bd088f00930 Mon Sep 17 00:00:00 2001 From: TRaSH Date: Mon, 15 Feb 2021 19:34:35 +0100 Subject: [PATCH] Several small changes and checks ```yml - Added: .pages for better sorting - Renamed: Integration to Integration-Setup - Added: Several Folders - Added: placeholders for the empty folders - MD-Fixes: Discord-Permissions.md - MD-Fixes: Bazarr.md - MD-Fixes: Better-Uptime.md ``` --- docs/Notifiarr/.pages | 12 ++++ docs/Notifiarr/Discord-Permissions.md | 6 +- .../Bazarr.md | 7 +- .../Better-Uptime.md | 62 +++++++++--------- .../images/Bazarr/configuration.png | Bin .../images/Bazarr/instructions.png | Bin .../images/Bazarr/open-configuration.png | Bin .../images/Bazarr/reaction.png | Bin .../images/Bazarr/triggers-channels.png | Bin .../images/Better-Uptime/configuration.png | Bin .../Better-Uptime/open-configuration.png | Bin .../Better-Uptime/triggers-channels.png | Bin docs/Notifiarr/Notification-History/index.md | 1 + docs/Notifiarr/Transcode-History/index.md | 1 + docs/Notifiarr/Translations/index.md | 1 + docs/Notifiarr/Trending/index.md | 1 + 16 files changed, 56 insertions(+), 35 deletions(-) create mode 100644 docs/Notifiarr/.pages rename docs/Notifiarr/{Integrations => Integrations-Setup}/Bazarr.md (88%) rename docs/Notifiarr/{Integrations => Integrations-Setup}/Better-Uptime.md (92%) rename docs/Notifiarr/{Integrations => Integrations-Setup}/images/Bazarr/configuration.png (100%) rename docs/Notifiarr/{Integrations => Integrations-Setup}/images/Bazarr/instructions.png (100%) rename docs/Notifiarr/{Integrations => Integrations-Setup}/images/Bazarr/open-configuration.png (100%) rename docs/Notifiarr/{Integrations => Integrations-Setup}/images/Bazarr/reaction.png (100%) rename docs/Notifiarr/{Integrations => Integrations-Setup}/images/Bazarr/triggers-channels.png (100%) rename docs/Notifiarr/{Integrations => Integrations-Setup}/images/Better-Uptime/configuration.png (100%) rename docs/Notifiarr/{Integrations => Integrations-Setup}/images/Better-Uptime/open-configuration.png (100%) rename docs/Notifiarr/{Integrations => Integrations-Setup}/images/Better-Uptime/triggers-channels.png (100%) create mode 100644 docs/Notifiarr/Notification-History/index.md create mode 100644 docs/Notifiarr/Transcode-History/index.md create mode 100644 docs/Notifiarr/Translations/index.md create mode 100644 docs/Notifiarr/Trending/index.md diff --git a/docs/Notifiarr/.pages b/docs/Notifiarr/.pages new file mode 100644 index 000000000..2ba254e9a --- /dev/null +++ b/docs/Notifiarr/.pages @@ -0,0 +1,12 @@ +nav: + - Quick Start: Quick-Start.md + - Discord Permissions: Discord-Permissions.md + - Integrations-Setup + - Media-Requests + - Notification-History + - Transcode-History + - Trending + - Translations + + + diff --git a/docs/Notifiarr/Discord-Permissions.md b/docs/Notifiarr/Discord-Permissions.md index a88c18ff7..fd5189bfa 100644 --- a/docs/Notifiarr/Discord-Permissions.md +++ b/docs/Notifiarr/Discord-Permissions.md @@ -4,11 +4,11 @@ This can be a struggle depending on how you have your server setup. If you want --- -I will work on the assumption you have created a role called **Bots** already with this and assigned the Notifiarr bot to it. With that said, right click on your server name at the top and pick `Server Settings > Roles`. Click on the Bots role so the permissions list loads. +I will work on the assumption you have created a role called **Bots** already with this and assigned the Notifiarr bot to it. With that said, right click on your server name at the top and pick `Server Settings > Roles`. Click on the Bots role so the permissions list loads. > Yes I am aware that adding the bot automatically creates a **Notifiarr** role but most will rather leave that one hidden and use an existing role. If you want to use that one, make sure all the same permissions are applied to it. -**Required permissions** +## **Required permissions** 1. `View Channels` - The bot needs this role to generate a channel list so you can assign which notifications go to which channels on your server. If the channel is a private channel, you may also need to adjust channel specific permissions. @@ -29,6 +29,6 @@ I will work on the assumption you have created a role called **Bots** already wi --- -If you manage your channels with individual permissions **plus** bot permissions, you will need to adjust them accordingly so the bot can do its job. If you have permissions mis-configured then the site will auto disable the integration after 25 Discord API errors. If you are using reactions and get API errors, the site will auto remove the reaction. If you are using the bot and have cleanup history enabled and get API errors, the site will auto disable that. +If you manage your channels with individual permissions **plus** bot permissions, you will need to adjust them accordingly so the bot can do its job. If you have permissions mis-configured then the site will auto disable the integration after 25 Discord API errors. If you are using reactions and get API errors, the site will auto remove the reaction. If you are using the bot and have cleanup history enabled and get API errors, the site will auto disable that. You will know when the site does this with a big red notice on top of the setup page that explains the error that Discord reported and what action was taken. All you have to do is fix the issue and re-enable what the site disabled from that point. diff --git a/docs/Notifiarr/Integrations/Bazarr.md b/docs/Notifiarr/Integrations-Setup/Bazarr.md similarity index 88% rename from docs/Notifiarr/Integrations/Bazarr.md rename to docs/Notifiarr/Integrations-Setup/Bazarr.md index 35e1bb508..cc41e6b28 100644 --- a/docs/Notifiarr/Integrations/Bazarr.md +++ b/docs/Notifiarr/Integrations-Setup/Bazarr.md @@ -9,6 +9,7 @@ Reaction example: --- ## Trigger options + ![!triggers-channels](images/Bazarr/triggers-channels.png "Triggers and Channels") 1. Triggers @@ -22,6 +23,7 @@ Reaction example: --- ## Configuration + ![!open-configuration](images/Bazarr/open-configuration.png "Open Configuration Window") Click the **cog icon** to open the configuration options for Bazarr. @@ -30,12 +32,13 @@ Click the **cog icon** to open the configuration options for Bazarr. 1. Open integration specific instructions 1. Choose the notification format -1. Enable reactions for *arr notifications when a subtitle is found if the associated *arr notification can be found +1. Enable reactions for `*arr` notifications when a subtitle is found if the associated `*arr` notification can be found ### Instructions + ![!instructions](images/Bazarr/instructions.png "Instructions Window") 1. How to enable notifications from within Bazarr 1. How to enable notifications of a 2nd instance from within Bazarr -3. Test the notification from Notifiarr to Discord +1. Test the notification from Notifiarr to Discord - This will ensure your server, channel and permissions are set properly in Discord. diff --git a/docs/Notifiarr/Integrations/Better-Uptime.md b/docs/Notifiarr/Integrations-Setup/Better-Uptime.md similarity index 92% rename from docs/Notifiarr/Integrations/Better-Uptime.md rename to docs/Notifiarr/Integrations-Setup/Better-Uptime.md index 2ba38fbcb..e570c4b1e 100644 --- a/docs/Notifiarr/Integrations/Better-Uptime.md +++ b/docs/Notifiarr/Integrations-Setup/Better-Uptime.md @@ -1,30 +1,32 @@ -# Better Uptime Integration - -> This integration allows for notifications from Better Uptime utilizng their webhook system - ---- - -## Trigger options -![!triggers-channels](images/Better-Uptime/triggers-channels.png "Triggers and Channels") - -1. Triggers - - `Started` - Sent when Better Uptime detects an issue with a site you are monitoring - - `Ack` (Acknowledged) - Sent when you mark the issue as acknowledged through Better Uptime - - `Resoled` - Sent when the site you are monitoring returns a successful response -1. Channel - - Pick a channel from your server to send these notifications - ---- - -## Configuration -![!open-configuration](images/Better-Uptime/open-configuration.png "Open Configuration Window") - -Click the **cog icon** to open the configuration options for Better Uptime. - -![!configuration](images/Better-Uptime/configuration.png "Configuration Window") - -1. Notification colors for each trigger type -1. Notification content options that you can turn on/off to show in the notifications -1. Better Uptime team id that is used to link the Incident in the notification - -**NOTE:** This integration sends a single notification for all triggers. After the first one is sent, the rest will update the existing notification in the chain. \ No newline at end of file +# Better Uptime Integration + +> This integration allows for notifications from Better Uptime utilizing their webhook system + +--- + +## Trigger options + +![!triggers-channels](images/Better-Uptime/triggers-channels.png "Triggers and Channels") + +1. Triggers + - `Started` - Sent when Better Uptime detects an issue with a site you are monitoring + - `Ack` (Acknowledged) - Sent when you mark the issue as acknowledged through Better Uptime + - `Resoled` - Sent when the site you are monitoring returns a successful response +1. Channel + - Pick a channel from your server to send these notifications + +--- + +## Configuration + +![!open-configuration](images/Better-Uptime/open-configuration.png "Open Configuration Window") + +Click the **cog icon** to open the configuration options for Better Uptime. + +![!configuration](images/Better-Uptime/configuration.png "Configuration Window") + +1. Notification colors for each trigger type +1. Notification content options that you can turn on/off to show in the notifications +1. Better Uptime team id that is used to link the Incident in the notification + +**NOTE:** This integration sends a single notification for all triggers. After the first one is sent, the rest will update the existing notification in the chain. diff --git a/docs/Notifiarr/Integrations/images/Bazarr/configuration.png b/docs/Notifiarr/Integrations-Setup/images/Bazarr/configuration.png similarity index 100% rename from docs/Notifiarr/Integrations/images/Bazarr/configuration.png rename to docs/Notifiarr/Integrations-Setup/images/Bazarr/configuration.png diff --git a/docs/Notifiarr/Integrations/images/Bazarr/instructions.png b/docs/Notifiarr/Integrations-Setup/images/Bazarr/instructions.png similarity index 100% rename from docs/Notifiarr/Integrations/images/Bazarr/instructions.png rename to docs/Notifiarr/Integrations-Setup/images/Bazarr/instructions.png diff --git a/docs/Notifiarr/Integrations/images/Bazarr/open-configuration.png b/docs/Notifiarr/Integrations-Setup/images/Bazarr/open-configuration.png similarity index 100% rename from docs/Notifiarr/Integrations/images/Bazarr/open-configuration.png rename to docs/Notifiarr/Integrations-Setup/images/Bazarr/open-configuration.png diff --git a/docs/Notifiarr/Integrations/images/Bazarr/reaction.png b/docs/Notifiarr/Integrations-Setup/images/Bazarr/reaction.png similarity index 100% rename from docs/Notifiarr/Integrations/images/Bazarr/reaction.png rename to docs/Notifiarr/Integrations-Setup/images/Bazarr/reaction.png diff --git a/docs/Notifiarr/Integrations/images/Bazarr/triggers-channels.png b/docs/Notifiarr/Integrations-Setup/images/Bazarr/triggers-channels.png similarity index 100% rename from docs/Notifiarr/Integrations/images/Bazarr/triggers-channels.png rename to docs/Notifiarr/Integrations-Setup/images/Bazarr/triggers-channels.png diff --git a/docs/Notifiarr/Integrations/images/Better-Uptime/configuration.png b/docs/Notifiarr/Integrations-Setup/images/Better-Uptime/configuration.png similarity index 100% rename from docs/Notifiarr/Integrations/images/Better-Uptime/configuration.png rename to docs/Notifiarr/Integrations-Setup/images/Better-Uptime/configuration.png diff --git a/docs/Notifiarr/Integrations/images/Better-Uptime/open-configuration.png b/docs/Notifiarr/Integrations-Setup/images/Better-Uptime/open-configuration.png similarity index 100% rename from docs/Notifiarr/Integrations/images/Better-Uptime/open-configuration.png rename to docs/Notifiarr/Integrations-Setup/images/Better-Uptime/open-configuration.png diff --git a/docs/Notifiarr/Integrations/images/Better-Uptime/triggers-channels.png b/docs/Notifiarr/Integrations-Setup/images/Better-Uptime/triggers-channels.png similarity index 100% rename from docs/Notifiarr/Integrations/images/Better-Uptime/triggers-channels.png rename to docs/Notifiarr/Integrations-Setup/images/Better-Uptime/triggers-channels.png diff --git a/docs/Notifiarr/Notification-History/index.md b/docs/Notifiarr/Notification-History/index.md new file mode 100644 index 000000000..fdffa2a0f --- /dev/null +++ b/docs/Notifiarr/Notification-History/index.md @@ -0,0 +1 @@ +# placeholder diff --git a/docs/Notifiarr/Transcode-History/index.md b/docs/Notifiarr/Transcode-History/index.md new file mode 100644 index 000000000..fdffa2a0f --- /dev/null +++ b/docs/Notifiarr/Transcode-History/index.md @@ -0,0 +1 @@ +# placeholder diff --git a/docs/Notifiarr/Translations/index.md b/docs/Notifiarr/Translations/index.md new file mode 100644 index 000000000..fdffa2a0f --- /dev/null +++ b/docs/Notifiarr/Translations/index.md @@ -0,0 +1 @@ +# placeholder diff --git a/docs/Notifiarr/Trending/index.md b/docs/Notifiarr/Trending/index.md new file mode 100644 index 000000000..fdffa2a0f --- /dev/null +++ b/docs/Notifiarr/Trending/index.md @@ -0,0 +1 @@ +# placeholder