From e7669c6a537d5cf0d68e15d3a7ccbfdbd0134b49 Mon Sep 17 00:00:00 2001 From: Robert Dailey Date: Sat, 19 Oct 2024 10:20:07 -0500 Subject: [PATCH] Correct mdx extension for all markdown links --- docs/_configs-common.mdx | 10 ++++----- docs/_include-templates-dir.mdx | 6 ++--- docs/backups.mdx | 2 +- docs/behavior/cache.mdx | 4 ++-- docs/behavior/custom-formats.mdx | 2 +- docs/behavior/include.mdx | 4 ++-- docs/behavior/migration-system.mdx | 4 ++-- docs/behavior/quality-profiles.mdx | 4 ++-- docs/cli/common.mdx | 2 +- docs/cli/config/config-create.mdx | 4 ++-- docs/cli/config/index.mdx | 4 ++-- docs/cli/config/list/config-list-local.mdx | 2 +- .../cli/config/list/config-list-templates.mdx | 2 +- docs/cli/config/list/index.mdx | 4 ++-- docs/cli/delete/delete-custom-formats.mdx | 4 ++-- docs/cli/delete/index.mdx | 2 +- docs/cli/index.mdx | 8 +++---- docs/cli/list/index.mdx | 6 ++--- docs/cli/list/list-custom-formats.mdx | 4 ++-- docs/cli/list/list-naming.mdx | 4 ++-- docs/cli/list/list-qualities.mdx | 2 +- docs/cli/main.mdx | 8 +++---- docs/cli/migrate.mdx | 4 ++-- docs/cli/sync.mdx | 2 +- docs/file-structure.mdx | 2 +- docs/getting-started.mdx | 22 +++++++++---------- docs/guide-configs.mdx | 2 +- docs/installation/docker.mdx | 2 +- docs/installation/index.mdx | 6 ++--- docs/installation/manual-install.mdx | 2 +- docs/installation/unraid.mdx | 4 ++-- docs/schema-validation.mdx | 4 ++-- docs/sqp-configs.mdx | 2 +- docs/troubleshooting/errors-warnings.mdx | 8 +++---- docs/troubleshooting/reporting-issues.mdx | 6 ++--- docs/upgrade-guide/v2.0.mdx | 4 ++-- docs/upgrade-guide/v3.0.mdx | 6 ++--- docs/upgrade-guide/v5.0.mdx | 6 ++--- docs/upgrade-guide/v6.0.mdx | 2 +- docs/upgrade-guide/v7.0.mdx | 10 ++++----- docs/upgrade-guide/v8.0.mdx | 2 +- docs/wiki-main.mdx | 4 ++-- docs/yaml/config-reference/basic.mdx | 4 ++-- docs/yaml/config-reference/custom-formats.mdx | 6 ++--- docs/yaml/config-reference/include.mdx | 6 ++--- docs/yaml/config-reference/index.mdx | 20 ++++++++--------- docs/yaml/config-reference/media-naming.mdx | 4 ++-- .../config-reference/quality-definition.mdx | 2 +- .../config-reference/quality-profiles.mdx | 4 ++-- docs/yaml/configuration-examples.mdx | 8 +++---- docs/yaml/environment-variables.mdx | 2 +- docs/yaml/secrets-reference.mdx | 8 +++---- docs/yaml/settings-reference/index.mdx | 4 ++-- 53 files changed, 130 insertions(+), 130 deletions(-) diff --git a/docs/_configs-common.mdx b/docs/_configs-common.mdx index fe32d26..870fba5 100644 --- a/docs/_configs-common.mdx +++ b/docs/_configs-common.mdx @@ -56,8 +56,8 @@ section][include-qp]. Additional custom formats can be added to the configuration file in the same way as normal. -[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 +[cli]: ./cli/config/config-create.mdx#template +[file-structure]: ./file-structure.mdx#default-yaml +[behavior]: ./behavior/include.mdx +[config-qp]: ./yaml/config-reference/quality-profiles.mdx +[include-qp]: ./behavior/include.mdx#quality-profiles diff --git a/docs/_include-templates-dir.mdx b/docs/_include-templates-dir.mdx index 1f1295c..ed4a96a 100644 --- a/docs/_include-templates-dir.mdx +++ b/docs/_include-templates-dir.mdx @@ -29,6 +29,6 @@ directory for those. ::: -[include]: /yaml/config-reference/include.md -[configdirective]: /yaml/config-reference/include.md#config -[configsdir]: /file-structure.md#config-directory +[include]: /yaml/config-reference/include.mdx +[configdirective]: /yaml/config-reference/include.mdx#config +[configsdir]: /file-structure.mdx#config-directory diff --git a/docs/backups.mdx b/docs/backups.mdx index 9ccbe4b..624210a 100644 --- a/docs/backups.mdx +++ b/docs/backups.mdx @@ -19,4 +19,4 @@ accepted by Recyclarr. Files and directories *not* listed above are considered unimportant for backup purposes. -[app-data]: /file-structure.md#appdata-directory +[app-data]: /file-structure.mdx#appdata-directory diff --git a/docs/behavior/cache.mdx b/docs/behavior/cache.mdx index 5b0efd0..527eeb0 100644 --- a/docs/behavior/cache.mdx +++ b/docs/behavior/cache.mdx @@ -40,5 +40,5 @@ replace CFs that it doesn't own (i.e. that aren't recorded in the cache). Once r added for it in the cache, which means you can set `replace_existing_custom_formats` back to `false`. -[app-data]: /file-structure.md#appdata-directory -[replacecf]: /yaml/config-reference/custom-formats.md#replace-existing-custom-formats +[app-data]: /file-structure.mdx#appdata-directory +[replacecf]: /yaml/config-reference/custom-formats.mdx#replace-existing-custom-formats diff --git a/docs/behavior/custom-formats.mdx b/docs/behavior/custom-formats.mdx index 6b8c861..1981bde 100644 --- a/docs/behavior/custom-formats.mdx +++ b/docs/behavior/custom-formats.mdx @@ -28,4 +28,4 @@ in order to do anything to it (update or delete). See the [Cache] page. -[Cache]: ./cache.md +[Cache]: ./cache.mdx diff --git a/docs/behavior/include.mdx b/docs/behavior/include.mdx index 528c916..765c493 100644 --- a/docs/behavior/include.mdx +++ b/docs/behavior/include.mdx @@ -18,7 +18,7 @@ title: YAML Includes A specific method of including a YAML file (e.g. `config: myfile.yml`). The [reference docs][includeref] contain a comprehensive list of all include directives. -[includeref]: /yaml/config-reference/include.md +[includeref]: /yaml/config-reference/include.mdx ### YAML-Specific Terms {#yaml-terms} @@ -393,6 +393,6 @@ custom_formats: ### Include File Structure {#file-structure} -import IncludeDirectory from '../_include-templates-dir.md' +import IncludeDirectory from '../_include-templates-dir.mdx' diff --git a/docs/behavior/migration-system.mdx b/docs/behavior/migration-system.mdx index ab60ce6..4984c7f 100644 --- a/docs/behavior/migration-system.mdx +++ b/docs/behavior/migration-system.mdx @@ -22,8 +22,8 @@ Migration Steps can fail. When this happens, instructions are provided to the us and/or perform those steps manually. Regardless of the reason, Recyclarr will immediately exit and cannot proceed until the advice output during the previous execution is followed. -[sync]: ../cli/sync.md -[mig]: ../cli/migrate.md +[sync]: ../cli/sync.mdx +[mig]: ../cli/migrate.mdx ## Failure & Recovery diff --git a/docs/behavior/quality-profiles.mdx b/docs/behavior/quality-profiles.mdx index 0fdbd15..dd47aa1 100644 --- a/docs/behavior/quality-profiles.mdx +++ b/docs/behavior/quality-profiles.mdx @@ -33,8 +33,8 @@ Because disabled (disallowed) qualities are not technically non-functional, the give you some flexibility in how those disabled qualities impact you when they're missing from the [`qualities` list][qpqualities] in your configuration YAML. -[qpsort]: /yaml/config-reference/quality-profiles.md#quality-sort -[qpqualities]: /yaml/config-reference/quality-profiles.md#qualities +[qpsort]: /yaml/config-reference/quality-profiles.mdx#quality-sort +[qpqualities]: /yaml/config-reference/quality-profiles.mdx#qualities ### Top Sort {#top-sort} diff --git a/docs/cli/common.mdx b/docs/cli/common.mdx index 6c631af..a8fe0a6 100644 --- a/docs/cli/common.mdx +++ b/docs/cli/common.mdx @@ -21,7 +21,7 @@ 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 +directory](/file-structure.mdx#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 diff --git a/docs/cli/config/config-create.mdx b/docs/cli/config/config-create.mdx index 38beb0e..cf86b33 100644 --- a/docs/cli/config/config-create.mdx +++ b/docs/cli/config/config-create.mdx @@ -12,11 +12,11 @@ recyclarr config create [OPTIONS] ## Description Create a starter configuration YAML file. The location of this file is the [application data -directory](/file-structure.md#appdata-directory). +directory](/file-structure.mdx#appdata-directory). ## Options -Visit [Common Options](../common.md) to read about options usable by all commands. +Visit [Common Options](../common.mdx) to read about options usable by all commands. ### `-p|--path` {#path} diff --git a/docs/cli/config/index.mdx b/docs/cli/config/index.mdx index 166c96b..8756764 100644 --- a/docs/cli/config/index.mdx +++ b/docs/cli/config/index.mdx @@ -14,5 +14,5 @@ Commands used to perform configuration-related operations. ## Commands -- [recyclarr config create](config-create.md) -- [recyclarr config list](list/index.md) +- [recyclarr config create](config-create.mdx) +- [recyclarr config list](list/index.mdx) diff --git a/docs/cli/config/list/config-list-local.mdx b/docs/cli/config/list/config-list-local.mdx index 2f5e0ba..19d6141 100644 --- a/docs/cli/config/list/config-list-local.mdx +++ b/docs/cli/config/list/config-list-local.mdx @@ -13,7 +13,7 @@ recyclarr config list local Lists all configuration files according to the [default YAML file][1] locations. -[1]: /file-structure.md#default-yaml +[1]: /file-structure.mdx#default-yaml ## Command Line Examples diff --git a/docs/cli/config/list/config-list-templates.mdx b/docs/cli/config/list/config-list-templates.mdx index 6f6b663..4896a11 100644 --- a/docs/cli/config/list/config-list-templates.mdx +++ b/docs/cli/config/list/config-list-templates.mdx @@ -23,7 +23,7 @@ If specified, this command lists the IDs of all include templates. In contrast t templates, which are only usable with the `config create` command, include templates may only be included with the [`include` property][include]. -[include]: /yaml/config-reference/include.md +[include]: /yaml/config-reference/include.mdx ## Command Line Examples diff --git a/docs/cli/config/list/index.mdx b/docs/cli/config/list/index.mdx index a3756cd..deec55f 100644 --- a/docs/cli/config/list/index.mdx +++ b/docs/cli/config/list/index.mdx @@ -14,5 +14,5 @@ Commands used to perform configuration-related operations. ## Commands -- [recyclarr config list local](config-list-local.md) -- [recyclarr config list templates](config-list-templates.md) +- [recyclarr config list local](config-list-local.mdx) +- [recyclarr config list templates](config-list-templates.mdx) diff --git a/docs/cli/delete/delete-custom-formats.mdx b/docs/cli/delete/delete-custom-formats.mdx index 13c01bf..79769d1 100644 --- a/docs/cli/delete/delete-custom-formats.mdx +++ b/docs/cli/delete/delete-custom-formats.mdx @@ -51,7 +51,7 @@ radarr: api_key: f7e74ba6c80046e39e076a27af5a8444 ``` -[configref]: /yaml/config-reference/basic.md +[configref]: /yaml/config-reference/basic.mdx ### `[cf_names]` {#cf-names} @@ -66,7 +66,7 @@ Any custom formats provided here are ignored if the `--all` option is used. ## Options -Visit [Common Options](../common.md) to read about options usable by all commands. +Visit [Common Options](../common.mdx) to read about options usable by all commands. ### `-a|--all` {#all} diff --git a/docs/cli/delete/index.mdx b/docs/cli/delete/index.mdx index e210257..f360c96 100644 --- a/docs/cli/delete/index.mdx +++ b/docs/cli/delete/index.mdx @@ -14,4 +14,4 @@ Allows deletion of various resources in a known, remote service such as Radarr a ## Commands -- [recyclarr delete custom-formats](delete-custom-formats.md) +- [recyclarr delete custom-formats](delete-custom-formats.mdx) diff --git a/docs/cli/index.mdx b/docs/cli/index.mdx index 3999e56..af7080d 100644 --- a/docs/cli/index.mdx +++ b/docs/cli/index.mdx @@ -25,12 +25,12 @@ or angle-brackets (e.g. ``). ## Commands -Also visit the [Common Options](common.md) page to learn about options and environment variables +Also visit the [Common Options](common.mdx) page to learn about options and environment variables usable across *all* commands. -- [recyclarr](main.md) -- [recyclarr sync](sync.md) +- [recyclarr](main.mdx) +- [recyclarr sync](sync.mdx) - [recyclarr list](list) -- [recyclarr migrate](migrate.md) +- [recyclarr migrate](migrate.mdx) - [recyclarr config](config) - [recyclarr delete](delete) diff --git a/docs/cli/list/index.mdx b/docs/cli/list/index.mdx index 06a25ef..3ff2473 100644 --- a/docs/cli/list/index.mdx +++ b/docs/cli/list/index.mdx @@ -14,6 +14,6 @@ Provides a series of commands used to list information in the guide. ## Commands -- [recyclarr list custom-formats](list-custom-formats.md) -- [recyclarr list qualities](list-qualities.md) -- [recyclarr list naming](list-naming.md) +- [recyclarr list custom-formats](list-custom-formats.mdx) +- [recyclarr list qualities](list-qualities.mdx) +- [recyclarr list naming](list-naming.mdx) diff --git a/docs/cli/list/list-custom-formats.mdx b/docs/cli/list/list-custom-formats.mdx index 7217fac..a77525e 100644 --- a/docs/cli/list/list-custom-formats.mdx +++ b/docs/cli/list/list-custom-formats.mdx @@ -71,14 +71,14 @@ Valid values for this argument are: ## Options -Visit [Common Options](../common.md) to read about options usable by all commands. +Visit [Common Options](../common.mdx) to read about options usable by all commands. ### `--score-sets` {#score-sets} Instead of listing custom format names, output a list of score sets that can be used with the [`score_set` YAML property][scoresetyaml]. -[scoresetyaml]: /yaml/config-reference/quality-profiles.md#score-set +[scoresetyaml]: /yaml/config-reference/quality-profiles.mdx#score-set ### `--raw` {#raw} diff --git a/docs/cli/list/list-naming.mdx b/docs/cli/list/list-naming.mdx index bcf4625..10770d6 100644 --- a/docs/cli/list/list-naming.mdx +++ b/docs/cli/list/list-naming.mdx @@ -25,7 +25,7 @@ media_naming: series: default ``` -[ref]: /yaml/config-reference/media-naming.md +[ref]: /yaml/config-reference/media-naming.mdx ## Examples @@ -52,4 +52,4 @@ values for this argument are: ## Options -Visit [Common Options](../common.md) to read about options usable by all commands. +Visit [Common Options](../common.mdx) to read about options usable by all commands. diff --git a/docs/cli/list/list-qualities.mdx b/docs/cli/list/list-qualities.mdx index acf4b7b..b9ec93c 100644 --- a/docs/cli/list/list-qualities.mdx +++ b/docs/cli/list/list-qualities.mdx @@ -38,4 +38,4 @@ values for this argument are: ## Options -Visit [Common Options](../common.md) to read about options usable by all commands. +Visit [Common Options](../common.mdx) to read about options usable by all commands. diff --git a/docs/cli/main.mdx b/docs/cli/main.mdx index e94b45a..23fde11 100644 --- a/docs/cli/main.mdx +++ b/docs/cli/main.mdx @@ -19,7 +19,7 @@ asking for help. ## Commands -- [recyclarr sync](sync.md) -- [recyclarr list](list/index.md) -- [recyclarr migrate](migrate.md) -- [recyclarr config](config/index.md) +- [recyclarr sync](sync.mdx) +- [recyclarr list](list/index.mdx) +- [recyclarr migrate](migrate.mdx) +- [recyclarr config](config/index.mdx) diff --git a/docs/cli/migrate.mdx b/docs/cli/migrate.mdx index f3740d5..a558a75 100644 --- a/docs/cli/migrate.mdx +++ b/docs/cli/migrate.mdx @@ -12,8 +12,8 @@ recyclarr migrate [OPTIONS] ## Description Performs upgrade steps that may be needed between major versions of Recyclarr. Visit the [Migration -System](/behavior/migration-system.md) page to read more about it. +System](/behavior/migration-system.mdx) page to read more about it. ## Options -Visit [Common Options](common.md) to read about options usable by all commands. +Visit [Common Options](common.mdx) to read about options usable by all commands. diff --git a/docs/cli/sync.mdx b/docs/cli/sync.mdx index ae8d969..6f2d3fb 100644 --- a/docs/cli/sync.mdx +++ b/docs/cli/sync.mdx @@ -42,7 +42,7 @@ recyclarr sync sonarr One or more paths to YAML configuration files. If this argument is not specified, default configuration files will be used according to rules documented on the [File -Structure](../file-structure.md) page. +Structure](../file-structure.mdx) page. :::tip diff --git a/docs/file-structure.mdx b/docs/file-structure.mdx index 2314671..5be1c62 100644 --- a/docs/file-structure.mdx +++ b/docs/file-structure.mdx @@ -58,6 +58,6 @@ instead. ## Include Templates Directory {#include-directory} -import IncludeDirectory from './_include-templates-dir.md' +import IncludeDirectory from './_include-templates-dir.mdx' diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx index d6fd2c9..10a46be 100644 --- a/docs/getting-started.mdx +++ b/docs/getting-started.mdx @@ -6,7 +6,7 @@ title: Getting Started :::warning -Please make sure you've reviewed the various [installation methods](installation/index.md) before +Please make sure you've reviewed the various [installation methods](installation/index.mdx) before getting started here. ::: @@ -21,7 +21,7 @@ want to get started with a minimal configuration file.
Docker -[Installation Instructions](installation/docker.md) +[Installation Instructions](installation/docker.mdx) The steps below assume you are using Docker Compose with a service named `recyclarr`. You are responsible for translating these steps appropriately for other solutions like Docker Swarm, @@ -34,8 +34,8 @@ Kubernetes, raw Docker, etc. and [examples] pages to assist you in understanding an editing other parts of the file as you see fit. -If you're using [Cron Mode](installation/docker.md#cron-mode), your work ends here. If you want to -verify the behavior by [running manually](installation/docker.md#manual-mode), then you can execute +If you're using [Cron Mode](installation/docker.mdx#cron-mode), your work ends here. If you want to +verify the behavior by [running manually](installation/docker.mdx#manual-mode), then you can execute `docker compose run --rm recyclarr sync` to update all instances using the configuration provided in the previous step. @@ -44,7 +44,7 @@ the previous step.
Manual Installation -[Installation Instructions](installation/manual-install.md) +[Installation Instructions](installation/manual-install.mdx) 1. Run `recyclarr config create` to create a starter `recyclarr.yml` file in the [application data directory][appdata]. @@ -60,16 +60,16 @@ the previous step. Each command supports printing help on the command line. Simply run `recyclarr --help` for the main help output and a list of commands. You can then see the help for each command by running `recyclarr [command] --help`, where `[command]` is one of those commands (e.g. `sync`). You can also visit the -[CLI Reference](cli/index.md) page for detailed documentation as well. +[CLI Reference](cli/index.mdx) page for detailed documentation as well. :::tip If you want to organize your configuration into multiple YAML files, learn about [how YAML files are -loaded](file-structure.md#default-yaml) and look at [examples of how to split your -files](yaml/configuration-examples.md) +loaded](file-structure.mdx#default-yaml) and look at [examples of how to split your +files](yaml/configuration-examples.mdx) ::: -[appdata]: /file-structure.md#appdata-directory -[reference]: /yaml/config-reference/index.md -[examples]: /yaml/configuration-examples.md +[appdata]: /file-structure.mdx#appdata-directory +[reference]: /yaml/config-reference/index.mdx +[examples]: /yaml/configuration-examples.mdx diff --git a/docs/guide-configs.mdx b/docs/guide-configs.mdx index 217e957..8471e13 100644 --- a/docs/guide-configs.mdx +++ b/docs/guide-configs.mdx @@ -5,7 +5,7 @@ sidebar_class_name: hidden # It's in the nav title bar hide_table_of_contents: true --- -import Session from './_configs-common.md'; +import Session from './_configs-common.mdx'; Recyclarr offers pre-built configuration files that can be used as a straightforward method of deploying one of more of the TRaSH Guides profiles: diff --git a/docs/installation/docker.mdx b/docs/installation/docker.mdx index 620c783..72d6d58 100644 --- a/docs/installation/docker.mdx +++ b/docs/installation/docker.mdx @@ -300,7 +300,7 @@ This runs it without any command or options, which will result in this mode bein ## Troubleshooting -See the [Troubleshooting](/troubleshooting/errors-warnings.md#docker) page. +See the [Troubleshooting](/troubleshooting/errors-warnings.mdx#docker) page. ## Advanced Configuration diff --git a/docs/installation/index.mdx b/docs/installation/index.mdx index 49e6cdd..e265731 100644 --- a/docs/installation/index.mdx +++ b/docs/installation/index.mdx @@ -11,7 +11,7 @@ Unraid is a popular platform for many Recyclarr users. Because of this, there ar methods specific to this platform. If you do not use Unraid, please refer to the Docker or Manual installation methods. -[Unraid Instructions](unraid.md) +[Unraid Instructions](unraid.mdx) ## Docker Compose @@ -19,10 +19,10 @@ For most platforms, it is recommended to use the Docker Image to install Recycla method, you get to enjoy an easier installation process without having to worry about things like file locations, dependencies, etc. -[Docker Compose Instructions](docker.md) +[Docker Compose Instructions](docker.mdx) ## Manual Installation Install and run Recyclarr directly on your host machine. This does not utilize Docker at all. -[Manual Instructions](manual-install.md) +[Manual Instructions](manual-install.mdx) diff --git a/docs/installation/manual-install.mdx b/docs/installation/manual-install.mdx index a304add..8bfbfe4 100644 --- a/docs/installation/manual-install.mdx +++ b/docs/installation/manual-install.mdx @@ -8,7 +8,7 @@ sidebar_position: 3 The following dependencies are required on **all** platforms. -- Git v2.0 or greater ([Instructions for Windows Users](/installation/tips/git-install.md)) +- Git v2.0 or greater ([Instructions for Windows Users](/installation/tips/git-install.mdx)) ## Download diff --git a/docs/installation/unraid.mdx b/docs/installation/unraid.mdx index c541f77..2d6d201 100644 --- a/docs/installation/unraid.mdx +++ b/docs/installation/unraid.mdx @@ -17,8 +17,8 @@ Unraid. **All credit for these solutions goes to their respective authors and ma ::: -[Docker]: ./docker.md -[Manual]: ./manual-install.md +[Docker]: ./docker.mdx +[Manual]: ./manual-install.mdx ## Community App (Template) diff --git a/docs/schema-validation.mdx b/docs/schema-validation.mdx index e618e6c..fb6f2c2 100644 --- a/docs/schema-validation.mdx +++ b/docs/schema-validation.mdx @@ -70,6 +70,6 @@ The `yaml.customTags` setting is documented [here][custom-tags]. [vs-code-setup]: https://code.visualstudio.com/docs/setup/setup-overview [vs-code-ext-inst]: https://code.visualstudio.com/learn/get-started/extensions [yaml]: https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml -[Configuration YAML]: /yaml/config-reference/index.md#schema -[Settings YAML]: /yaml/settings-reference/index.md#schema +[Configuration YAML]: /yaml/config-reference/index.mdx#schema +[Settings YAML]: /yaml/settings-reference/index.mdx#schema [custom-tags]: https://github.com/redhat-developer/vscode-yaml#extension-settings diff --git a/docs/sqp-configs.mdx b/docs/sqp-configs.mdx index 82aad88..f579ba3 100644 --- a/docs/sqp-configs.mdx +++ b/docs/sqp-configs.mdx @@ -5,7 +5,7 @@ sidebar_class_name: hidden hide_table_of_contents: true --- -import Session from './_configs-common.md'; +import Session from './_configs-common.mdx'; Recyclarr offers pre-built configuration files that can be used as a straightforward method of deploying one of more of the TRaSH Guides profiles: diff --git a/docs/troubleshooting/errors-warnings.mdx b/docs/troubleshooting/errors-warnings.mdx index e6a3ae7..bcb5950 100644 --- a/docs/troubleshooting/errors-warnings.mdx +++ b/docs/troubleshooting/errors-warnings.mdx @@ -70,10 +70,10 @@ There are three ways to provide configuration data: When using the CLI, the files provided *must* exist. To solve this error, use one of the above methods to provide your YAML configuration. See the documentation about [default YAML configuration][default-yaml] for more information. There is also [an -example](/yaml/configuration-examples.md#yaml-structure) showing multiple configuration files +example](/yaml/configuration-examples.mdx#yaml-structure) showing multiple configuration files and their structure. -[default-yaml]: file-structure.md#default-yaml +[default-yaml]: file-structure.mdx#default-yaml
@@ -84,7 +84,7 @@ Incompatible value assigned/used at line 7: Invalid cast from 'System.String' to As of version 4.0.0, the syntax for `quality_definitions` changed. You must manually change to the -new format. See [the v4 release notes](/upgrade-guide/v4.0.md). +new format. See [the v4 release notes](/upgrade-guide/v4.0.mdx).
@@ -116,7 +116,7 @@ None Yet... ## Non-Docker Errors & Solutions {#non-docker-errors} The troubleshooting steps documented here are for the non-docker version of Recyclarr (running it -directly on a host machine). The [Docker](installation/docker.md) page has troubleshooting steps as +directly on a host machine). The [Docker](installation/docker.mdx) page has troubleshooting steps as well.
diff --git a/docs/troubleshooting/reporting-issues.mdx b/docs/troubleshooting/reporting-issues.mdx index 26e1a1b..539dea5 100644 --- a/docs/troubleshooting/reporting-issues.mdx +++ b/docs/troubleshooting/reporting-issues.mdx @@ -32,7 +32,7 @@ Please review the checklist below and ensure you have done the following. - **Read the documentation!** - If you need help with an error or warning message, check the [Errors & - Warnings](errors-warnings.md) page. + Warnings](errors-warnings.mdx) page. - Search the Github [issues] and [discussion] sections for existing answers to your questions or to see if your issue has already been reported. - If you are getting errors, *read the error messages and try to understand them!* Many of @@ -88,7 +88,7 @@ by Recyclarr. :::tip -Use [secrets](/yaml/secrets-reference.md) so you don't have to do this by hand! +Use [secrets](/yaml/secrets-reference.mdx) so you don't have to do this by hand! ::: @@ -97,7 +97,7 @@ particular, the Base URL and API Key for each service you've configured. Typical this information shared to others when you request help or file bug reports on Github. As such, you should ensure that this information is redacted. You can do this in multiple ways. -- Use [secrets](/yaml/secrets-reference.md) +- Use [secrets](/yaml/secrets-reference.mdx) - Manually edit your YAML before sharing it to redact `base_url` and `api_key` values. ## Reporting Issues diff --git a/docs/upgrade-guide/v2.0.mdx b/docs/upgrade-guide/v2.0.mdx index b05b052..768c854 100644 --- a/docs/upgrade-guide/v2.0.mdx +++ b/docs/upgrade-guide/v2.0.mdx @@ -101,5 +101,5 @@ These are explained in more detail on the [Migration System] page. - Migration steps have been added. See the `v2.0` migration steps documented on the [Migration System] page. -[Configuration Reference]: yaml/config-reference/index.md -[Migration System]: /behavior/migration-system.md +[Configuration Reference]: yaml/config-reference/index.mdx +[Migration System]: /behavior/migration-system.mdx diff --git a/docs/upgrade-guide/v3.0.mdx b/docs/upgrade-guide/v3.0.mdx index 68db3ac..d9ed69c 100644 --- a/docs/upgrade-guide/v3.0.mdx +++ b/docs/upgrade-guide/v3.0.mdx @@ -37,11 +37,11 @@ The `recyclarr.yml` configuration file is no longer loaded if it's sitting next Recyclarr executable lives on the filesystem. From now on, the only valid (default) location for this file is at the root of your [Application Data Directory][appdata]. -[appdata]: /file-structure.md#appdata-directory +[appdata]: /file-structure.mdx#appdata-directory ### Git Required On Host Systems -If you're using the [Manual Installation](/installation/manual-install.md) method, you must now +If you're using the [Manual Installation](/installation/manual-install.mdx) method, you must now install Git on your system in order to run Recyclarr. Prior to v3.0.0, Recyclarr had an implementation of Git bundled inside it, so it would work even if you didn't have Git installed. However, this implementation caused multiple issues, including a continuously-growing Repo @@ -49,7 +49,7 @@ directory. Due to the limitations of that implementation, Recyclarr now runs git commands on your shell, and thus requires the git executable to be installed and on your `PATH` (or you can specify a path to it -via your [settings](/yaml/settings-reference/repositories.md)). +via your [settings](/yaml/settings-reference/repositories.mdx)). ## Deprecations diff --git a/docs/upgrade-guide/v5.0.mdx b/docs/upgrade-guide/v5.0.mdx index c9b84e9..e61fc97 100644 --- a/docs/upgrade-guide/v5.0.mdx +++ b/docs/upgrade-guide/v5.0.mdx @@ -154,9 +154,9 @@ The following CLI commands were previously deprecated and now removed: | Removed Command | Replacement (New) Command | | ------------------------- | --------------------------------------------------------- | -| `recyclarr radarr` | [`recyclarr sync radarr`](/cli/sync.md) | -| `recyclarr sonarr` | [`recyclarr sync sonarr`](/cli/sync.md) | -| `recyclarr create-config` | [`recyclarr config create`](/cli/config/config-create.md) | +| `recyclarr radarr` | [`recyclarr sync radarr`](/cli/sync.mdx) | +| `recyclarr sonarr` | [`recyclarr sync sonarr`](/cli/sync.mdx) | +| `recyclarr create-config` | [`recyclarr config create`](/cli/config/config-create.mdx) | ### Settings: Repository Changes diff --git a/docs/upgrade-guide/v6.0.mdx b/docs/upgrade-guide/v6.0.mdx index 01b015a..a9ec611 100644 --- a/docs/upgrade-guide/v6.0.mdx +++ b/docs/upgrade-guide/v6.0.mdx @@ -27,7 +27,7 @@ reset_unmatched_scores: For more details on the *current syntax*, see the [relevant YAML reference section][resetref]. -[resetref]: /yaml/config-reference/quality-profiles.md#reset-unmatched-scores +[resetref]: /yaml/config-reference/quality-profiles.mdx#reset-unmatched-scores ### Sonarr Minimum Version diff --git a/docs/upgrade-guide/v7.0.mdx b/docs/upgrade-guide/v7.0.mdx index 73ee5cd..f71f1d2 100644 --- a/docs/upgrade-guide/v7.0.mdx +++ b/docs/upgrade-guide/v7.0.mdx @@ -14,7 +14,7 @@ If you are not running Recyclarr on MacOS, **no action is needed!** ::: -The [app data directory](../file-structure.md#appdata-directory) path has changed for only the MacOS +The [app data directory](../file-structure.mdx#appdata-directory) path has changed for only the MacOS platform. This is due to a [breaking change][net8] introduced in .NET 8. In Recyclarr v6 and earlier, the path to the app data directory is: @@ -34,8 +34,8 @@ moved. Use the [`recyclarr migrate`][cmd] command to have Recyclarr attempt to m for you. [net8]: https://learn.microsoft.com/en-us/dotnet/core/compatibility/core-libraries/8.0/getfolderpath-unix -[mig]: ../behavior/migration-system.md -[cmd]: ../cli/migrate.md +[mig]: ../behavior/migration-system.mdx +[cmd]: ../cli/migrate.mdx ## Removed Sonarr v3 Support {#sonarr-removed} @@ -63,5 +63,5 @@ the Trash Guides. hand-written Sonarr v3 configuration with a pre-made template instead. See the [`config create`][config_create] command for details on how to list available templates and create them. -[ref]: /yaml/config-reference/index.md -[config_create]: ../cli/config/config-create.md#template +[ref]: /yaml/config-reference/index.mdx +[config_create]: ../cli/config/config-create.mdx#template diff --git a/docs/upgrade-guide/v8.0.mdx b/docs/upgrade-guide/v8.0.mdx index 3759d49..004d3d6 100644 --- a/docs/upgrade-guide/v8.0.mdx +++ b/docs/upgrade-guide/v8.0.mdx @@ -20,7 +20,7 @@ in the past. Deprecations are always mentioned in release notes for feature rele ## Dedicated Includes Directory {#include-dir} The root directory for relative local include paths has changed. Previously, relative paths provided -to the [`config` include directive](../yaml/config-reference/include.md#config) were rooted in +to the [`config` include directive](../yaml/config-reference/include.mdx#config) were rooted in `${appdatadir}/configs`. Putting includes in the `configs` directory is no longer supported. Going forward, all includes should reside in `${appdatadir}/includes`. diff --git a/docs/wiki-main.mdx b/docs/wiki-main.mdx index 6dc2122..ff49b2b 100644 --- a/docs/wiki-main.mdx +++ b/docs/wiki-main.mdx @@ -8,9 +8,9 @@ slug: / Recyclarr is a command-line application that will automatically synchronize recommended settings from the [TRaSH guides](https://trash-guides.info/) to your Sonarr/Radarr instances. -- [Features](features.md) +- [Features](features.mdx) - [Installation](installation) -- [Getting Started](getting-started.md) +- [Getting Started](getting-started.mdx) ## Contributing to the Wiki diff --git a/docs/yaml/config-reference/basic.mdx b/docs/yaml/config-reference/basic.mdx index e62ea8e..7a3cdf0 100644 --- a/docs/yaml/config-reference/basic.mdx +++ b/docs/yaml/config-reference/basic.mdx @@ -59,7 +59,7 @@ means that if you relocate your instances to a new URL (change of port, hostname Recyclarr *will think this is a completely different instance*. This has implications with regards to [caching]. -[caching]: /behavior/cache.md#relocating +[caching]: /behavior/cache.mdx#relocating ::: @@ -78,4 +78,4 @@ This property can be implicitly set via secrets if you follow a naming conventio ::: -[impliciturlkey]: /yaml/secrets-reference.md#implicit-url-key +[impliciturlkey]: /yaml/secrets-reference.mdx#implicit-url-key diff --git a/docs/yaml/config-reference/custom-formats.mdx b/docs/yaml/config-reference/custom-formats.mdx index 44e3c2a..9f3ed21 100644 --- a/docs/yaml/config-reference/custom-formats.mdx +++ b/docs/yaml/config-reference/custom-formats.mdx @@ -36,7 +36,7 @@ service_type: For details on the way Custom Formats are synchronized, visit the [Custom Format Synchronization][cfsync] page. -[cfsync]: /behavior/custom-formats.md +[cfsync]: /behavior/custom-formats.mdx ## `delete_old_custom_formats` {#delete-old-custom-formats} @@ -126,7 +126,7 @@ The name of *an existing* quality profile. This name is **not required** to appe shown. If you want this profile to be created by Recyclarr, you must also add an entry for it in the previously mentioned `quality_profiles` list. -[qps]: ./quality-profiles.md +[qps]: ./quality-profiles.mdx ### `score` {#qp-score} @@ -137,5 +137,5 @@ A positive or negative number representing the score to apply to *all* custom fo without having to delete them. [guidecfs]: https://trash-guides.info/Radarr/Radarr-collection-of-custom-formats/ -[listcfs]: /cli/list/list-custom-formats.md +[listcfs]: /cli/list/list-custom-formats.mdx [radarrjson]: https://github.com/TRaSH-/Guides/tree/master/docs/json/radarr/cf diff --git a/docs/yaml/config-reference/include.mdx b/docs/yaml/config-reference/include.mdx index e770670..5b2c62e 100644 --- a/docs/yaml/config-reference/include.mdx +++ b/docs/yaml/config-reference/include.mdx @@ -26,7 +26,7 @@ taking the contents of one YAML file and merging it into the source (root) YAML. For more details about how includes and merging work, see the [Include Behavior] page. -[Include Behavior]: /behavior/include.md +[Include Behavior]: /behavior/include.mdx ::: @@ -51,7 +51,7 @@ Use this directive to include YAML files on your local filesystem. An absolute or relative path to the YAML file you wish to include. If relative paths are used, see the [app data directory][appdata] page for where those files should be located. -[appdata]: /file-structure.md#include-directory +[appdata]: /file-structure.mdx#include-directory ### Examples @@ -84,7 +84,7 @@ will be included. IDs matching include templates from a non-matching service typ To get a list of eligible **include templates**, see the [`config list templates` command][list]. -[list]: /cli/config/list/config-list-templates.md#include +[list]: /cli/config/list/config-list-templates.mdx#include ::: diff --git a/docs/yaml/config-reference/index.mdx b/docs/yaml/config-reference/index.mdx index 1f10e66..3d79654 100644 --- a/docs/yaml/config-reference/index.mdx +++ b/docs/yaml/config-reference/index.mdx @@ -16,18 +16,18 @@ multiple ways, offering a lot of flexibility: from the file relevant for the specific service command you specified (e.g. `recyclarr sync sonarr` will only read the Sonarr config in the file, even if Radarr config is present). -- Use [a `secrets.yml` file](/yaml/secrets-reference.md) to keep sensitive values out of your +- Use [a `secrets.yml` file](/yaml/secrets-reference.mdx) to keep sensitive values out of your configuration files. This prevents accidentally sharing api_keys and other sensitive values when sharing configurations. For various examples, see the [Configuration Examples] page. -[Configuration Examples]: /yaml/configuration-examples.md +[Configuration Examples]: /yaml/configuration-examples.mdx :::tip Remember If you do not specify the `--config` argument, the program will look for default configuration files -according to the rules documented on [the file structure](/file-structure.md#default-yaml) page. +according to the rules documented on [the file structure](/file-structure.mdx#default-yaml) page. ::: @@ -47,7 +47,7 @@ documented below. ## Schema Validation {#schema} -Visit the [Schema Validation](/schema-validation.md) page for detailed instructions. +Visit the [Schema Validation](/schema-validation.mdx) page for detailed instructions. Add this comment to the top of your YAML file: @@ -57,9 +57,9 @@ Add this comment to the top of your YAML file: ## Reference Pages -- [Basic Setup](basic.md) -- [Custom Formats](custom-formats.md) -- [Quality Definition](quality-definition.md) -- [Quality Profiles](quality-profiles.md) -- [Include](include.md) -- [Media Naming](media-naming.md) +- [Basic Setup](basic.mdx) +- [Custom Formats](custom-formats.mdx) +- [Quality Definition](quality-definition.mdx) +- [Quality Profiles](quality-profiles.mdx) +- [Include](include.mdx) +- [Media Naming](media-naming.mdx) diff --git a/docs/yaml/config-reference/media-naming.mdx b/docs/yaml/config-reference/media-naming.mdx index 523e125..74ba702 100644 --- a/docs/yaml/config-reference/media-naming.mdx +++ b/docs/yaml/config-reference/media-naming.mdx @@ -47,7 +47,7 @@ If set to `true`, this results in the "Rename Movies" checkbox in the Radarr UI A naming format taken from the "Key" column of the "Standard Movie Format" table shown in the output of the [`list naming radarr` command][list-radarr]. -[list-radarr]: /cli/list/list-naming.md +[list-radarr]: /cli/list/list-naming.mdx ## Sonarr @@ -111,4 +111,4 @@ of the [`list naming sonarr` command][list-sonarr]. A naming format taken from the "Key" column of the "Anime Episode Format" table shown in the output of the [`list naming sonarr` command][list-sonarr]. -[list-sonarr]: /cli/list/list-naming.md +[list-sonarr]: /cli/list/list-naming.mdx diff --git a/docs/yaml/config-reference/quality-definition.mdx b/docs/yaml/config-reference/quality-definition.mdx index 92c1372..e354b40 100644 --- a/docs/yaml/config-reference/quality-definition.mdx +++ b/docs/yaml/config-reference/quality-definition.mdx @@ -50,4 +50,4 @@ match the maximum quality. A value such as `0.5` will keep it halfway between th ::: -[listqualities]: /cli/list/list-qualities.md +[listqualities]: /cli/list/list-qualities.mdx diff --git a/docs/yaml/config-reference/quality-profiles.mdx b/docs/yaml/config-reference/quality-profiles.mdx index 6153754..c635cb6 100644 --- a/docs/yaml/config-reference/quality-profiles.mdx +++ b/docs/yaml/config-reference/quality-profiles.mdx @@ -114,7 +114,7 @@ well. Use the `list custom-formats --score-sets` command to get a list of available score sets that can be used with this property. Visit the [relevant CLI reference page][cliscoresets] for more information. -[cliscoresets]: /cli/list/list-custom-formats.md#score-sets +[cliscoresets]: /cli/list/list-custom-formats.mdx#score-sets ::: @@ -248,4 +248,4 @@ page. ::: -[qp_behavior]: /behavior/quality-profiles.md#order-matters +[qp_behavior]: /behavior/quality-profiles.mdx#order-matters diff --git a/docs/yaml/configuration-examples.mdx b/docs/yaml/configuration-examples.mdx index 0ba942d..269d9a7 100644 --- a/docs/yaml/configuration-examples.mdx +++ b/docs/yaml/configuration-examples.mdx @@ -15,7 +15,7 @@ import TOCInline from '@theme/TOCInline'; Create a single configuration file (use the default `recyclarr.yml` if you want to simplify your CLI usage by not being required to specify `--config`) and put all of the configuration in there. This -example refers to sensitive values by [using a `secrets.yml` file](secrets-reference.md). +example refers to sensitive values by [using a `secrets.yml` file](secrets-reference.mdx). ```yml sonarr: @@ -111,7 +111,7 @@ sonarr: You must include **all** qualities that you want to be present in the quality profile. This is because `quality_profile`s [replace] those from a referenced include. -[replace]: /behavior/include.md#detail-qualities +[replace]: /behavior/include.mdx#detail-qualities ## Synchronize a lot of custom formats for a single quality profile @@ -282,7 +282,7 @@ you add/remove custom formats from a profile. ## What does the file structure look like with multiple YAML configuration files? {#yaml-structure} Suppose you want to use `recyclarr.yml` and multiple YAML files in the `configs` directory, as -documented on [the File Structure page](/file-structure.md#default-yaml). What would that file +documented on [the File Structure page](/file-structure.mdx#default-yaml). What would that file structure look like? Using docker as an example, it would look like this: @@ -309,7 +309,7 @@ In the above example: - The names of the YAML files under `configs/` can be whatever you want. - The YAML files under `includes/` are not loaded, but can be [referenced]. -[referenced]: /yaml/config-reference/include.md#config +[referenced]: /yaml/config-reference/include.mdx#config ## Merge multiple config templates into a single file with a single instance {#merge-single-instance} diff --git a/docs/yaml/environment-variables.mdx b/docs/yaml/environment-variables.mdx index 1615af0..25bbe25 100644 --- a/docs/yaml/environment-variables.mdx +++ b/docs/yaml/environment-variables.mdx @@ -8,7 +8,7 @@ Environment variables may be used in your configuration YAML files to provide ce dynamically. This is especially useful in certain environments, such as Kubernetes. [Secrets] serve a similar purpose, however those still require you to modify a file to provide the values. -[Secrets]: ./secrets-reference.md +[Secrets]: ./secrets-reference.mdx :::note Version Requirement diff --git a/docs/yaml/secrets-reference.mdx b/docs/yaml/secrets-reference.mdx index 81e5b05..13620c9 100644 --- a/docs/yaml/secrets-reference.mdx +++ b/docs/yaml/secrets-reference.mdx @@ -10,7 +10,7 @@ remember to manually redact each time. Specify secrets with a `secrets.yml` located in your [application data directory][appdata]. -[appdata]: /file-structure.md#appdata-directory +[appdata]: /file-structure.mdx#appdata-directory The following rules apply: @@ -63,9 +63,9 @@ configurations can be implicitly set by following a naming convention for certai Where `` is the [name of the instance][instance_name] in your YAML file. -[base_url]: /yaml/config-reference/basic.md#base-url -[api_key]: /yaml/config-reference/basic.md#api-key -[instance_name]: /yaml/config-reference/basic.md#instance-name +[base_url]: /yaml/config-reference/basic.mdx#base-url +[api_key]: /yaml/config-reference/basic.mdx#api-key +[instance_name]: /yaml/config-reference/basic.mdx#instance-name ### Order of Precedence {#implicit-key-url-precedence} diff --git a/docs/yaml/settings-reference/index.mdx b/docs/yaml/settings-reference/index.mdx index c83f5b6..97ab880 100644 --- a/docs/yaml/settings-reference/index.mdx +++ b/docs/yaml/settings-reference/index.mdx @@ -25,11 +25,11 @@ rest alone. ::: -[app-data]: /file-structure.md#appdata-directory +[app-data]: /file-structure.mdx#appdata-directory ## Schema Validation {#schema} -Visit the [Schema Validation](/schema-validation.md) page for detailed instructions. +Visit the [Schema Validation](/schema-validation.mdx) page for detailed instructions. Add this comment to the top of your YAML file: