Upgrade to Docusaurus v3

NOTE: Cannot be completed right now due to the `docusaurus-theme-github-codeblock` plugin not supporting v3.
recyclarr · May 31, 2024 · e97c247 · e97c247
1 parent 62c03ef
commit e97c247
Show file tree

Hide file tree

Showing 24 changed files with 5,107 additions and 3,028 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -120,7 +120,7 @@ please use the general guidelines below to know which admonition types to use in
   Advice or tips that help the user. Topics might not be directly related to surrounding subject
   matter.
 
-- 🟡 **CAUTION** (`:::caution`)<br/>
+- 🟡 **CAUTION** (`:::warning`)<br/>
   Warning messages about an action or piece of information. Things the user should heed, but it
   won't be the end of the world if they don't.
 

diff --git a/UpgradeDocusaurus.ps1 b/UpgradeDocusaurus.ps1
@@ -3,4 +3,6 @@ yarn upgrade --latest `
     "@docusaurus/core" `
     "@docusaurus/preset-classic" `
     "@docusaurus/module-type-aliases" `
-    "@iconify/react"
+    "docusaurus-mdx-checker" `
+    "@iconify/react" `
+    "docusaurus-theme-github-codeblock"
diff --git a/docs/_configs-common.md b/docs/_configs-common.md
@@ -1,16 +1,16 @@
 These pre-built configuration files are composed of two primary elements:
 
-- Includes<br/>
+- **Includes**<br/>
   [Include templates][include-templates] are utilized to synchronize all mandatory elements of any
   given guide profile. These are split into `quality_definition`, `quality_profile` and
-  `custom_formats` elements. If any of these are not desired, they can be commented out.
-  The content of these include templates can be found in the
-  [Recyclarr config-templates GitHub repository][config-templates-repo].
+  `custom_formats` elements. If any of these are not desired, they can be commented out. The content
+  of these include templates can be found in the [Recyclarr config-templates GitHub
+  repository][config-templates-repo].
 
   [include-templates]: https://recyclarr.dev/wiki/yaml/config-reference/include/#template
   [config-templates-repo]: https://github.com/recyclarr/config-templates
 
-- Custom Formats<br/>
+- **Custom Formats**<br/>
   Custom formats that are added to the pre-built configuration file directly - i.e., not by way of
   an include - allow the user to choose from one or more profile variations. These choices mirror
   those described on the TRaSH Guides profile pages. Comments are provided in the pre-built
@@ -21,45 +21,44 @@ These pre-built configuration files are composed of two primary elements:
 
 The pre-built configuration files can be deployed in two ways:
 
-- Via the CLI using [`recyclarr config create -t`][recyclarr-config-create-t].
-- Manually, by copying the contents of the relevant pre-built configuration file into a
-  [supported file location][file-structure]. The files can be found in the index below.
-
-  [recyclarr-config-create-t]: https://recyclarr.dev/wiki/cli/config/create/#-t--template
-  [file-structure]: https://recyclarr.dev/wiki/file-structure/#default-yaml
+- Via the CLI using [`recyclarr config create -t`][cli].
+- Manually, by copying the contents of the relevant pre-built configuration file into a [supported
+  file location][file-structure]. The files can be found in the index below.
 
 ## Customization
 
-:::caution
+:::warning
 
 The pre-built configuration files are designed as a simple mechanism to deploy one or more of the
-TRaSH Guides profiles, in exactly the same configuration as they appear on the guides pages.
-Minimal customization is possible, however more extensive customization usually necessitates
-building your own custom configuration file.
+TRaSH Guides profiles, in exactly the same configuration as they appear on the guides pages. Minimal
+customization is possible, however more extensive customization usually necessitates building your
+own custom configuration file.
 
 :::
 
-:::caution
+:::warning
 
 At this time, include templates can only be used with quality profiles that have the **same name**
-as shown in the equivalent guide profile page. The profile name is hard-coded into the
-include template.
+as shown in the equivalent guide profile page. The profile name is hard-coded into the include
+template.
 
 :::
 
-As the pre-built configuration files feature include templates, these will need to be overridden
-by custom configuration added to the configuration file.
-[Guidance is available on this behavior][behavior-include].
+As the pre-built configuration files feature include templates, these will need to be overridden by
+custom configuration added to the configuration file. [Guidance is available on this
+behavior][behavior].
 
-[behavior-include]: https://recyclarr.dev/wiki/behavior/include/.
 
-A common request is to add additional qualities to a [quality profile][quality-profile]. This is
-as simple as writing your own complete quality profile configuration and adding it to your
-configuration file. From there, the quality profile include template can either be commented out,
-or if left enabled then Recyclarr will process the customized configuration as described in the
-[include behavior section][behavior-include-quality-profiles].
+A common request is to add additional qualities to a [quality profile][config-qp]. This is as simple
+as writing your own complete quality profile configuration and adding it to your configuration file.
+From there, the quality profile include template can either be commented out, or if left enabled
+then Recyclarr will process the customized configuration as described in the [include behavior
+section][include-qp].
 
 Additional custom formats can be added to the configuration file in the same way as normal.
 
-[quality-profile]: https://recyclarr.dev/wiki/yaml/config-reference/quality-profiles/
-[behavior-include-quality-profiles]: https://recyclarr.dev/wiki/behavior/include/#quality-profiles
+[cli]: ./cli/config/config-create.md#template
+[file-structure]: ./file-structure.md#default-yaml
+[behavior]: ./behavior/include.md
+[config-qp]: ./yaml/config-reference/quality-profiles.md
+[include-qp]: ./behavior/include.md#quality-profiles
diff --git a/docs/behavior/include.md b/docs/behavior/include.md
@@ -91,7 +91,7 @@ You essentially start an include file as if it's everything under `instance_name
 Recyclarr handles includes using the following rules:
 
 1. Includes are processed from top to bottom, in order. Configuration is merged using specific
-   strategies discussed in the sections [Merge Operations](#operations) and [Merge
+   strategies discussed in the sections [Merge Behavior](#behavior) and [Merge
    Reference](#reference).
 1. The root configuration is merged into the final, aggregated include configuration data. Root
    configuration YAML always takes precedence over included YAML.

diff --git a/docs/behavior/quality-profiles.md b/docs/behavior/quality-profiles.md
@@ -42,15 +42,16 @@ When `quality_sort` is set to `top` (which is also the *default* if you do not s
 property), qualities and groups you *explicitly specify* in your YAML are sorted to the top of the
 list. *Unspecified* qualities appear at the bottom.
 
-:::caution Impact on Cutoff
+:::warning Impact on Cutoff
 
 If qualities are removed instead of disabled, this can cause unwanted downgrades of movie files.
 
 :::
 
 #### Example
 
-<details><summary>Click to Expand Example</summary>
+<details>
+<summary>Click to Expand Example</summary>
 
 ```yml
 quality_sort: top
@@ -77,15 +78,16 @@ When you sync this quality profile, it will look like this when you view it in t
 When `quality_sort` is set to `bottom`, qualities and groups you *explicitly specify* in your YAML
 are sorted to the bottom of the list. *Unspecified* qualities appear at the top.
 
-:::caution Impact on Cutoff
+:::warning Impact on Cutoff
 
 If qualities are removed instead of disabled, this can result in upgrades never happening.
 
 :::
 
 #### Example
 
-<details><summary>Click to Expand Example</summary>
+<details>
+<summary>Click to Expand Example</summary>
 
 Using the same example YAML from the previous section:
 

diff --git a/docs/cli/common.md b/docs/cli/common.md
@@ -19,8 +19,8 @@ generally will be too noisy for normal program usage.
 ### `--app-data` {#app-data}
 
 Overrides the normal, default location of the [application data
-directory](/file-structure.md#appdata-directory). Note that this option is mainly intended for
-usage in the official Docker image. It is not intended for normal use outside of that.
+directory](/file-structure.md#appdata-directory). Note that this option is mainly intended for usage
+in the official Docker image. It is not intended for normal use outside of that.
 
 If you'd like this behavior globally for all commands without having to specify this option, define
 an environment variable named `RECYCLARR_APP_DATA` with the same path. Note that if you have both

diff --git a/docs/cli/config/config-create.md b/docs/cli/config/config-create.md
@@ -54,7 +54,7 @@ recyclarr config create -t uhd-bluray-web -t remux-web-1080p
 
 ### `-f|--force`
 
-:::caution
+:::warning
 
 This is a destructive operation! Use carefully.
 

diff --git a/docs/cli/delete/delete-custom-formats.md b/docs/cli/delete/delete-custom-formats.md
@@ -82,7 +82,7 @@ If this option is used, any explicit CFs provided to the `[cf_names]` argument a
 
 If specified, performs the delete operation without a confirmation prompt.
 
-:::caution
+:::warning
 
 Know what you are doing before you use this option!
 

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -4,7 +4,7 @@ sidebar_position: 4
 title: Getting Started
 ---
 
-:::caution
+:::warning
 
 Please make sure you've reviewed the various [installation methods](installation/index.md) before
 getting started here.
@@ -18,9 +18,8 @@ which varies depending on your chosen platform.
 Choose the section below representing your chosen installation method and run those steps if you
 want to get started with a minimal configuration file.
 
-<details><summary>
-Docker
-</summary>
+<details>
+<summary>Docker</summary>
 
 [Installation Instructions](installation/docker.md)
 
@@ -42,9 +41,8 @@ the previous step.
 
 </details>
 
-<details><summary>
-Manual Installation
-</summary>
+<details>
+<summary>Manual Installation</summary>
 
 [Installation Instructions](installation/manual-install.md)
 

diff --git a/docs/installation/docker.md b/docs/installation/docker.md
@@ -30,7 +30,7 @@ because the `docker-compose.yml` file is a fantastic way to keep configuration d
 Thus, for the remainder of this page, all instruction and advice will be based on the example YAML
 below. I highly recommend you set up your own `docker-compose.yml` this way.
 
-:::caution
+:::warning
 
 The below example should not be used verbatim. It's meant for example purposes only. Copy & paste it
 but make the appropriate and necessary changes to it for your specific use case.
@@ -140,7 +140,7 @@ where:
 Using the table at the start of the Tags section, an example might be `2.1.3-dev.50` where `2.1.3`
 is the *current* next version after `2.1.2`.
 
-:::caution
+:::warning
 
 Prerelease tags do not live indefinitely. An unspecified *retention period* is applied to them,
 meaning that these tags are **permanently deleted from upstream docker registries** after that
@@ -207,9 +207,8 @@ one or the other depending on the following:
 
 See the respective sections below for whichever mode you wish to use.
 
-<details><summary>
-Using Docker Run
-</summary>
+<details>
+<summary>Using Docker Run</summary>
 
 When using `docker run` to invoke Recyclarr in manual mode, the container starts up, runs a
 user-specified operation, and then exits. This is semantically identical to running Recyclarr
@@ -248,9 +247,8 @@ containers will start to grow the more often you run it manually).
 
 </details>
 
-<details><summary>
-Using Docker Exec
-</summary>
+<details>
+<summary>Using Docker Exec</summary>
 
 Using `docker exec` for manual mode is similar to the previous section, except that it uses an
 already-running instance of the container to perform actions.

diff --git a/docs/installation/tips/git-install.md b/docs/installation/tips/git-install.md
@@ -30,7 +30,7 @@ Skip this section if you're using Chocolatey or Winget methods.
 
 :::
 
-:::caution
+:::warning
 
 Before proceeding, **close any open terminal windows** such as Powershell and CMD/Command Prompt.
 The Git installer will modify your `PATH` environment variable. Terminals will not reload updates to

diff --git a/docs/sqp-configs.md b/docs/sqp-configs.md
@@ -24,7 +24,7 @@ deploying one of more of the TRaSH Guides profiles:
 [radarr-sqp-4-trash]: https://trash-guides.info/SQP/4/
 [radarr-sqp-5-trash]: https://trash-guides.info/SQP/5/
 
-:::caution
+:::warning
 
 - The information provided on this page is for private use only and is not to be made public. :bangbang:
 - Users who have been provided with the link to this page **must** keep it private. :bangbang:

diff --git a/docs/troubleshooting/errors-warnings.md b/docs/troubleshooting/errors-warnings.md
@@ -7,7 +7,8 @@ This section contains a list of warnings you might see in your console output /
 usually caused by configuration issues or something else within the user's control to fix. Below are
 examples of messages you may see with some guidance on how to address them.
 
-<details><summary>
+<details>
+<summary>
 Custom format with trash ID e23edd2482476e595fb990b12e7c609c is duplicated 1 times in quality
 profile SD with the following scores: [500]
 </summary>
@@ -54,7 +55,8 @@ custom_formats:
 
 </details>
 
-<details><summary>
+<details>
+<summary>
 No configuration YAML files found
 </summary>
 
@@ -75,7 +77,8 @@ and their structure.
 
 </details>
 
-<details><summary>
+<details>
+<summary>
 Incompatible value assigned/used at line 7: Invalid cast from 'System.String' to
 'Recyclarr.TrashLib.Config.Services.QualityDefinitionConfig'
 </summary>
@@ -116,7 +119,8 @@ The troubleshooting steps documented here are for the non-docker version of Recy
 directly on a host machine). The [Docker](installation/docker.md) page has troubleshooting steps as
 well.
 
-<details><summary>
+<details>
+<summary>
 Failed to create CoreCLR, HRESULT: 0x8007000E
 </summary>
 

diff --git a/docs/troubleshooting/reporting-issues.md b/docs/troubleshooting/reporting-issues.md
@@ -3,7 +3,7 @@ id: help
 title: Getting Help
 ---
 
-:::caution
+:::warning
 
 Recyclarr may stop working at any time due to guide updates and changes in either Radarr or Sonarr.
 It is a priority to fix them in a timely manner. [Reporting][issues] such issues ASAP would be

diff --git a/docs/upgrade-guide/v5.0.md b/docs/upgrade-guide/v5.0.md
@@ -92,7 +92,7 @@ The reason for this change is due to quirky logic with specifying this flag mult
 same profile. Now that the flag is attached to a Quality Profile config, it will be more clear how
 the value will be set.
 
-:::caution
+:::warning
 
 At the moment, `quality_profiles` does **not create quality profiles for you!** You are still
 responsible for ensuring that the quality profile (in the above example, `SD`) exists.

diff --git a/docs/upgrade-guide/v7.0.md b/docs/upgrade-guide/v7.0.md
@@ -14,7 +14,7 @@ in the past. Deprecations are always mentioned in release notes for feature rele
 
 ## Path Change on MacOS {#osx-path-change}
 
-:::caution
+:::warning
 
 If you are not running Recyclarr on MacOS, **no action is needed!**
 

diff --git a/docs/yaml/config-reference/basic.md b/docs/yaml/config-reference/basic.md
@@ -53,7 +53,7 @@ This property can be implicitly set via secrets if you follow a naming conventio
 
 :::
 
-:::caution
+:::warning
 
 The `base_url` value is used to uniquely identify an instance of a service (such as Radarr). This
 means that if you relocate your instances to a new URL (change of port, hostname, or path),

diff --git a/docs/yaml/config-reference/quality-profiles.md b/docs/yaml/config-reference/quality-profiles.md
@@ -121,7 +121,7 @@ used with this property. Visit the [relevant CLI reference page][cliscoresets] f
 
 ## `min_format_score` {#min-format-score}
 
-:::caution
+:::warning
 
 This property is **not supported** with Sonarr v3!
 
@@ -161,7 +161,7 @@ list, this property is optional and will leave your manually set cutoff alone.
 
 ## `until_score` {#until-score}
 
-:::caution
+:::warning
 
 This property is **not supported** with Sonarr v3!
 
@@ -215,7 +215,7 @@ If this is omitted or set to `true`, this quality will be allowed. This is the e
 checking the box next to the quality in the Radarr or Sonarr UI. If set to `false`, this quality
 will be disallowed (unchecks the box).
 
-:::caution
+:::warning
 
 There are two distinct methods of disabling (disallowing) a quality: Either set this property to
 `false` or delete the quality from the list entirely. **Make sure you understand the behavioral

diff --git a/docs/yaml/config-reference/release-profiles.md b/docs/yaml/config-reference/release-profiles.md
@@ -37,7 +37,7 @@ service_type:
 
 **Optional.** *Default: No release profiles are synced*
 
-:::caution
+:::warning
 
 Release Profiles may not be used in Sonarr version 4 or greater!
 

diff --git a/docs/yaml/environment-variables.md b/docs/yaml/environment-variables.md
@@ -34,7 +34,7 @@ Where:
 - `my_default_value` is an **optional** default value to use if the specified environment variable
   is either not defined, a blank string, or contains only whitespace characters.
 
-:::caution
+:::warning
 
 If an environment variable cannot be found or does not have a value as defined above, *and* no
 default value is provided, an exception is thrown and configuration loading will fail for that