Merge branch 'master' into fix/Amazon-CF-should-not-match-episode-names

TRaSH-Guides · Jun 28, 2024 · b169d7e · b169d7e
2 parents c709002 + e18c483
commit b169d7e
Showing 150 changed files with 1,363 additions and 1,194 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,4 @@ site/
 /docs/Notifiarr/preview.bat
 /docs/Notifiarr/Integrations/_TEMPLATE.md
 /includes/flowcharts/.$radarr-flowchart.drawio.bkp
+.DS_Store
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -54,21 +54,21 @@ _Examples:_
 
 ## When doing a PR that is WIP
 
-When doing a PR that is in-progress and not yet complete / ready for review or not yet done fully, please ensure it is a **DRAFT Pull Request**
+When doing a PR that is in progress and not yet complete/ready for review or not yet done fully, please ensure it is a **DRAFT Pull Request**
 
 ## Radarr/Sonarr Custom Format (JSON)
 
 ### Release Group Reclassifications, Removals, or Additions
 
-- When adding a RlsGrp to a Custom Format for whatever reason, please add in the PR why it's added/removed/moved.
+- When adding a release group to a Custom Format for whatever reason, please add in the PR why it's added/removed/moved.
 
 ### General Guidelines
 
-- Custom Format name needs to match json name :bangbang:
-- No hashcode can exists multiple times :bangbang:
-- Tiers only hold release groups that have atleast done several dozen objectively high quality releases or are added for a specific reason. (If they do mainly niche stuff and/or foreign stuff they won't be added)
-- All Tier Groups must use retail sources. Fanrest and upscaled groups are forbidden. This is due to the high effort required and near impossibility to guarantee quality systematically without manual check every single movie.
-- JSON file format shall consist of the following TRaSH specific data appended to the json exported from Starr
+- Custom Format name needs to match JSON name :bangbang:
+- No hashcode can exist multiple times :bangbang:
+- Tiers only hold release groups that have at least done several dozen objectively high-quality releases or are added for a specific reason. (If they do mainly niche stuff and/or foreign stuff they won't be added)
+- All Tier Groups must use retail sources. Fanres and upscaled groups are forbidden. This is due to the high effort required and the near impossibility of guaranteeing quality systematically without manually checking every single movie.
+- JSON file format shall consist of the following TRaSH-specific data appended to the JSON exported from Starr
 
 ```json
 {
@@ -84,15 +84,15 @@ STARRJSONEXPORT
 
 General Structure
 
-- json file name - name of the [json file](#file-naming)
+- JSON file name - name of the [json file](#file-naming)
 - `trash_id` - Generated [HashCode](#hashcode) for the Custom Format
-- `trash_scores` - Json object of [score(s) for the Custom Format](#scoring). Note that Custom Formats with Default Scores of 0 should NOT have a `trash_scores.default`
+- `trash_scores` - JSON object of [score(s) for the Custom Format](#scoring). Note that Custom Formats with Default Scores of 0 should NOT have a `trash_scores.default`
 - `trash_regex` - Link to [regex test cases](#regex-test-cases) for regex
-- STARRJSONEXPORT - The exported custom format created within Starr. Note that this will have a leading `{` that will need to have the `trash` specific regex added after
+- STARRJSONEXPORT - The exported custom format created within Starr. Note that this will have a leading `{` that will need to have the trash-specific regex added after it.
 
 ### File Naming
 
-- JSON file names are always written in small letters, spaces are replaced by a dash, no spaces or special characters except a dash :bangbang:
+- JSON file names are always written in lowercase, spaces are replaced by a dash, and no spaces or special characters except a dash :bangbang:
 
 ### Hashcode
 
@@ -111,7 +111,7 @@ When adding a regex test case:
 - Replace the actual Series name/title with `Series`.
 - Replace the actual group name with `RlsGrp`
 
-When updating or adding a new CF the test case url (`trash_regex`) needs to be prepended to the exported from Starr json
+When updating or adding a new CF the test case URL (`trash_regex`) needs to be prepended to the exported from Starr JSON
 
 ```json
 {
@@ -139,7 +139,7 @@ When updating or adding a new CF the test case url (`trash_regex`) needs to be p
 
 - If a hashcode is needed **No** hashcode can exist multiple times :bangbang:
 - Use [this website](https://md5.gromweb.com) to generate an md5 hash
-- YAML file names are always written in small letters, spaces are replaced by a dash, no spaces or special characters except a dash :bangbang:
+- YAML file names are always written in small letters, spaces are replaced by a dash, and no spaces or special characters except a dash :bangbang:
 
 ## Recommendations
 
@@ -153,10 +153,12 @@ based on the `.vscode/extensions.json` file; you should install all of them.
 These prerequisites are taken from the [mkdocs installation instructions][mkdocinstall].
 
 - Install a recent version of [Python 3](https://www.python.org/).
-- `pip` is also required, but should come with Python. Run `pip --version` to check if its available and working. See the [installation instructions](https://pip.pypa.io/en/stable/installation/).
+- `pip` is also required, but should come with Python. Run `pip --version` to check if it's available and working. See the [installation instructions](https://pip.pypa.io/en/stable/installation/).
 
 [mkdocinstall]: https://www.mkdocs.org/user-guide/installation/
 
+Alternatively you can check out the docker container maintained by [zakkarry](https://github.com/zakkarry) specifically for development of the guides [here](https://github.com/zakkarry/mkdocs). The documentation in the README explains the installation process.
+
 ### Mkdocs Installation
 
 First, install mkdocs:

diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -50,14 +50,14 @@
       <b><a href="https://github.com/nemchik" style="color: #ffa500;">nemchik</a></b>
     </div>
 <div style="flex: 1 1 20%; background-color: #303850; border: 1px solid #373a42; padding: 10px; text-align: center;">
-      <img src="https://avatars.githubusercontent.com/u/39887349?v=4&v=4" style="width: 50px; border-radius: 50%;" alt="rg9400">
+      <img src="https://avatars.githubusercontent.com/u/123845855?v=4&v=4" style="width: 50px; border-radius: 50%;" alt="zakkarry">
       <br>
-      <b><a href="https://github.com/rg9400" style="color: #ffa500;">rg9400</a></b>
+      <b><a href="https://github.com/zakkarry" style="color: #ffa500;">zakkarry</a></b>
     </div>
 <div style="flex: 1 1 20%; background-color: #1e2129; border: 1px solid #373a42; padding: 10px; text-align: center;">
-      <img src="https://avatars.githubusercontent.com/u/123845855?v=4&v=4" style="width: 50px; border-radius: 50%;" alt="zakkarry">
+      <img src="https://avatars.githubusercontent.com/u/39887349?v=4&v=4" style="width: 50px; border-radius: 50%;" alt="rg9400">
       <br>
-      <b><a href="https://github.com/zakkarry" style="color: #ffa500;">zakkarry</a></b>
+      <b><a href="https://github.com/rg9400" style="color: #ffa500;">rg9400</a></b>
     </div>
 <div style="flex: 1 1 20%; background-color: #1e2129; border: 1px solid #373a42; padding: 10px; text-align: center;">
       <img src="https://avatars.githubusercontent.com/u/76420253?v=4&v=4" style="width: 50px; border-radius: 50%;" alt="sadstan">
@@ -329,6 +329,11 @@
       <br>
       <b><a href="https://github.com/OneRadRedDad" style="color: #ffa500;">OneRadRedDad</a></b>
     </div>
+<div style="flex: 1 1 20%; background-color: #303850; border: 1px solid #373a42; padding: 10px; text-align: center;">
+      <img src="https://avatars.githubusercontent.com/u/15257926?v=4&v=4" style="width: 50px; border-radius: 50%;" alt="2fst4u">
+      <br>
+      <b><a href="https://github.com/2fst4u" style="color: #ffa500;">2fst4u</a></b>
+    </div>
 <div style="flex: 1 1 20%; background-color: #303850; border: 1px solid #373a42; padding: 10px; text-align: center;">
       <img src="https://avatars.githubusercontent.com/u/12660469?v=4&v=4" style="width: 50px; border-radius: 50%;" alt="bobokun">
       <br>
@@ -349,7 +354,7 @@
       <br>
       <b><a href="https://github.com/f0e" style="color: #ffa500;">f0e</a></b>
     </div>
-<div style="flex: 1 1 20%; background-color: #303850; border: 1px solid #373a42; padding: 10px; text-align: center;">
+<div style="flex: 1 1 20%; background-color: #1e2129; border: 1px solid #373a42; padding: 10px; text-align: center;">
       <img src="https://avatars.githubusercontent.com/u/36236331?v=4&v=4" style="width: 50px; border-radius: 50%;" alt="garypiner">
       <br>
       <b><a href="https://github.com/garypiner" style="color: #ffa500;">garypiner</a></b>
@@ -374,7 +379,7 @@
       <br>
       <b><a href="https://github.com/sdaqo" style="color: #ffa500;">sdaqo</a></b>
     </div>
-<div style="flex: 1 1 20%; background-color: #1e2129; border: 1px solid #373a42; padding: 10px; text-align: center;">
+<div style="flex: 1 1 20%; background-color: #303850; border: 1px solid #373a42; padding: 10px; text-align: center;">
       <img src="https://avatars.githubusercontent.com/u/97920769?v=4&v=4" style="width: 50px; border-radius: 50%;" alt="snowballramen">
       <br>
       <b><a href="https://github.com/snowballramen" style="color: #ffa500;">snowballramen</a></b>
@@ -384,11 +389,6 @@
       <br>
       <b><a href="https://github.com/s0up4200" style="color: #ffa500;">s0up4200</a></b>
     </div>
-<div style="flex: 1 1 20%; background-color: #303850; border: 1px solid #373a42; padding: 10px; text-align: center;">
-      <img src="https://avatars.githubusercontent.com/u/15257926?v=4&v=4" style="width: 50px; border-radius: 50%;" alt="2fst4u">
-      <br>
-      <b><a href="https://github.com/2fst4u" style="color: #ffa500;">2fst4u</a></b>
-    </div>
 <div style="flex: 1 1 20%; background-color: #303850; border: 1px solid #373a42; padding: 10px; text-align: center;">
       <img src="https://avatars.githubusercontent.com/u/72708798?v=4&v=4" style="width: 50px; border-radius: 50%;" alt="nickavem">
       <br>
@@ -409,6 +409,11 @@
       <br>
       <b><a href="https://github.com/briandipalma" style="color: #ffa500;">briandipalma</a></b>
     </div>
+<div style="flex: 1 1 20%; background-color: #1e2129; border: 1px solid #373a42; padding: 10px; text-align: center;">
+      <img src="https://avatars.githubusercontent.com/u/132700?v=4&v=4" style="width: 50px; border-radius: 50%;" alt="rangzen">
+      <br>
+      <b><a href="https://github.com/rangzen" style="color: #ffa500;">rangzen</a></b>
+    </div>
 <div style="flex: 1 1 20%; background-color: #1e2129; border: 1px solid #373a42; padding: 10px; text-align: center;">
       <img src="https://avatars.githubusercontent.com/u/290461?v=4&v=4" style="width: 50px; border-radius: 50%;" alt="ChaseBro">
       <br>
@@ -424,7 +429,7 @@
       <br>
       <b><a href="https://github.com/dako98" style="color: #ffa500;">dako98</a></b>
     </div>
-<div style="flex: 1 1 20%; background-color: #1e2129; border: 1px solid #373a42; padding: 10px; text-align: center;">
+<div style="flex: 1 1 20%; background-color: #303850; border: 1px solid #373a42; padding: 10px; text-align: center;">
       <img src="https://avatars.githubusercontent.com/u/3601172?v=4&v=4" style="width: 50px; border-radius: 50%;" alt="dctr">
       <br>
       <b><a href="https://github.com/dctr" style="color: #ffa500;">dctr</a></b>
@@ -449,7 +454,7 @@
       <br>
       <b><a href="https://github.com/Seros" style="color: #ffa500;">Seros</a></b>
     </div>
-<div style="flex: 1 1 20%; background-color: #303850; border: 1px solid #373a42; padding: 10px; text-align: center;">
+<div style="flex: 1 1 20%; background-color: #1e2129; border: 1px solid #373a42; padding: 10px; text-align: center;">
       <img src="https://avatars.githubusercontent.com/u/2633890?v=4&v=4" style="width: 50px; border-radius: 50%;" alt="JackGameer">
       <br>
       <b><a href="https://github.com/JackGameer" style="color: #ffa500;">JackGameer</a></b>
@@ -474,7 +479,7 @@
       <br>
       <b><a href="https://github.com/KaitoKid" style="color: #ffa500;">KaitoKid</a></b>
     </div>
-<div style="flex: 1 1 20%; background-color: #1e2129; border: 1px solid #373a42; padding: 10px; text-align: center;">
+<div style="flex: 1 1 20%; background-color: #303850; border: 1px solid #373a42; padding: 10px; text-align: center;">
       <img src="https://avatars.githubusercontent.com/u/41852205?v=4&v=4" style="width: 50px; border-radius: 50%;" alt="kaiserbh">
       <br>
       <b><a href="https://github.com/kaiserbh" style="color: #ffa500;">kaiserbh</a></b>

diff --git a/README.md b/README.md
@@ -1,3 +1,3 @@
 # Guides mainly for the Starr Apps (Sonarr/Radarr) and everything related to it
 
-I have switched to MkDocs, sorry if I broke your links. The same content is available here: [trash-guides.info](https://trash-guides.info/)
+I have switched to MkDocs, sorry if we broke your links. The same content is available here: [trash-guides.info](https://trash-guides.info/)
diff --git a/docs/Bazarr/After-install-configuration.md b/docs/Bazarr/After-install-configuration.md
@@ -4,11 +4,11 @@ After you've installed everything it's best to check all of your settings,
 
 !!! warning
 
-    Bazarr only searches for subs for Episodes and Movies that are added after the install.
+    Bazarr only searches for subs of Episodes and Movies that are added after the installation.
 
     So you will need to set the preferred languages for your existing Shows and Movies.
 
-In this example I will show you how to do that with the series.
+In this example, we will show you how to do that with a series.
 
 ![!mass-edit](images/mass-edit.png)
 
@@ -17,7 +17,7 @@ click on `Mass Edit`
 ![!select-all](images/select-all.png)
 
 1. Select all.
-1. Select your Language Profile you created earlier.
+1. Select the Language Profile you created earlier.
 1. Click on `Save`.
 
 Then go back to your Movies home screen and do the same for your Movies.

diff --git a/docs/Bazarr/Setup-Guide.md b/docs/Bazarr/Setup-Guide.md
@@ -5,15 +5,15 @@
     In this guide we will try to explain the basic setup you need to do to get started with Bazarr.
     For a more detailed few of all the setting check the following [LINK](https://wiki.bazarr.media/Additional-Configuration/Settings/){:target="_blank" rel="noopener noreferrer"}.
 
-Before Bazarr works we need to setup and configure a few settings.
+Before Bazarr works we need to set up and configure a few settings.
 
 After installation and starting up, you open a browser and go to <http://ip_where_installed:6767>.
 
 ---
 
 ## Sonarr
 
-First we're going to setup Sonarr.
+First we're going to set up Sonarr.
 
 `Settings` => `Sonarr`
 
@@ -85,15 +85,15 @@ Click on `Add` and you will get an extra option
 
 !!! warning
 
-    **IF YOU GOT THE SAME VALUES ON BOTH SIDES THEN YOU DON'T NEED IT!!!**
+    **IF YOU HAVE THE SAME VALUES ON BOTH SIDES THEN YOU DON'T NEED IT!!!**
 
     **IT SHOULD ALSO BE REMOVED OR ELSE YOU WILL GET AN ERROR.**
 
 ![!Sonarr Path Mappings Mapped](images/qs-sonarr-path-mappings-mapped.png)
 
 !!! info
 
-    *If everything runs on Docker you normally don't need to use this except if you got messed up paths and then it would be smarter to fix those first to have consistent and well planned paths.*
+    *If everything runs on Docker you normally don't need to use this except if you got messed up paths and then it would be smarter to fix those first to have consistent and well-planned paths.*
 
     Please take a look at TRaSH's Hardlink Tutorial <https://trash-guides.info/hardlinks>
 
@@ -105,7 +105,7 @@ Click on `Add` and you will get an extra option
 
 ## Radarr
 
-Next we're going to setup Radarr.
+Next, we're going to set up Radarr.
 
 `Settings` => `Radarr`
 
@@ -150,7 +150,7 @@ Click on `Enabled`
 
         **Are your subs often out of sync or just bad? Raise the score!**
 
-1. Movies with those tags (case sensitive) in Radarr will be excluded from automatic downloading of subtitles. In Radarr you add a custom tag to a movie.
+1. Movies with those tags (case sensitive) in Radarr will be excluded from the automatic downloading of subtitles. In Radarr you add a custom tag to a movie.
 
 1. Automatic downloading of subtitles will only happen for monitored movies in Radarr.
 
@@ -160,7 +160,7 @@ Click on `Enabled`
 
     You should only use this section if Radarr and Bazarr use a different path to access the same files.
 
-    (for example if you run Radarr on a different device than Bazarr or have a Synology and mix packages with Docker.)
+    (for example, if you run Radarr on a different device than Bazarr or have a Synology and mix packages with Docker.)
 
 ![!Radarr Path Mappings](images/qs-radarr-path-mappings-add.png)
 
@@ -181,7 +181,7 @@ Click on `Add` and you will get an extra option
 
 !!! info
 
-    *If everything runs on Docker you normally don't need to use this except if you got messed up paths and then it would be smarter to fix those first to have consistent and well planned paths.*
+    *If everything runs on Docker you normally don't need to use this except if you got messed up paths and then it would be smarter to fix those first to have consistent and well-planned paths.*
 
     Please take a look at TRaSH's Hardlink Tutorial <https://trash-guides.info/hardlinks>
 
@@ -203,7 +203,7 @@ Here we're going to configure which subtitle languages you prefer/want.
 
 !!! warning
 
-    **We don't recommend enabling `Single Language` option unless absolutely required (ie: media player not supporting language code in subtitles filename). Results may vary.
+    **We don't recommend enabling the `Single Language` option unless required (ie: media player not supporting language code in subtitles filename). Results may vary.
 
     Be aware the language code (ex.: en) is not going to be included in the subtitles file name when enabling this.**
 
@@ -213,15 +213,15 @@ Here you select which languages you want for your subtitles, you can just start
 
 These languages are the subtitle languages you later use for the `Languages Profiles`
 
-In this example I selected `Dutch` and `English`.
+In this example, we've selected `Dutch` and `English`.
 
 ### Languages Profiles
 
 Select `Add New Profile`
 
 ![!Languages Profiles](images/qs-languages-profiles.png)
 
-1. How you want to name your language profile.
+1. How you want to name your Language Profile.
 1. Click on `Add` to add the languages you enabled earlier in [Subtitle Language](#subtitles-language).
 1. Select the languages you want to enable for your profile (Including the optional settings).
     - Forced => [FAQ - What are Forced Subtitles](https://wiki.bazarr.media/Troubleshooting/FAQ/#what-are-forced-subtitles){:target="\_blank" rel="noopener noreferrer"}
@@ -261,7 +261,7 @@ Here we're going to select which subtitle providers you want to use.
 ![!Providers](images/qs-providers.png)
 
 1. Click on the Plus sign box.
-1. Select the subtitle providers you would like to enable. It is best to select multiple providers and create/use an account with them especially when you got a lot of wanted subtitles. Some subtitle providers requires an extra paid Anti-Captcha Service.
+1. Select the subtitle providers you would like to enable. It is best to select multiple providers and create/use an account with them especially when you got a lot of wanted subtitles. Some subtitle providers require an extra paid Anti-Captcha Service.
 1. Your enabled providers.
 
 !!! tip
@@ -288,7 +288,7 @@ Here we will configure some extra settings for your subtitles
 
 1. Where you want your subtitles it's recommended to put them `AlongSide Media File`.
 1. If you want to upgrade previously downloaded subtitles.
-1. How many days to go back in history to upgrade them.
+1. How many days to go back in history for upgrading?
 1. If you want to upgrade manually downloaded subtitles.
 
 ### Anti-Captcha Options
@@ -308,7 +308,7 @@ Here you can select which Anti-Captcha provider you want to use.
 ![!Performance / Optimization](images/qs-performance-optimization.png)
 
 1. When searching for subtitles, Bazarr will search less frequently to limit calls to providers.
-1. Search multiple providers at once (Don't choose this on low powered devices).
+1. Search multiple providers at once (don't choose this on low-powered devices).
 1. If you want to use the embedded subtitles in the media files [More Info](https://wiki.bazarr.media/Additional-Configuration/Settings/#use-embedded-subtitles){:target="\_blank" rel="noopener noreferrer"}
 
 ### Automatic Subtitles Synchronization