diff --git a/docs/_configs-common.md b/docs/_configs-common.md new file mode 100644 index 0000000..363d73b --- /dev/null +++ b/docs/_configs-common.md @@ -0,0 +1,65 @@ +These pre-built configuration files are composed of two primary elements: + +- Includes
+ [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]. + + [include-templates]: https://recyclarr.dev/wiki/yaml/config-reference/include/#template + [config-templates-repo]: https://github.com/recyclarr/config-templates + +- Custom Formats
+ 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 + configuration files, although these are supplementary in nature and the relevant guide profile + page should be consulted for full information. + +## Deployment + +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 + +## Customization + +:::caution + +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. + +::: + +:::caution + +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 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]. + +[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]. + +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 diff --git a/docs/guide-configs.md b/docs/guide-configs.md index 87cadf5..217e957 100644 --- a/docs/guide-configs.md +++ b/docs/guide-configs.md @@ -5,6 +5,8 @@ sidebar_class_name: hidden # It's in the nav title bar hide_table_of_contents: true --- +import Session from './_configs-common.md'; + Recyclarr offers pre-built configuration files that can be used as a straightforward method of deploying one of more of the TRaSH Guides profiles: @@ -22,71 +24,7 @@ deploying one of more of the TRaSH Guides profiles: [sonarr-v4-anime-profiles-trash]: https://trash-guides.info/Sonarr/sonarr-setup-quality-profiles-anime/ [sonarr-v4-french-profiles-trash]: https://trash-guides.info/Sonarr/sonarr-setup-quality-profiles-french-en/ -These pre-built configuration files are composed of two primary elements: - -- Includes
- [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]. - - [include-templates]: https://recyclarr.dev/wiki/yaml/config-reference/include/#template - [config-templates-repo]: https://github.com/recyclarr/config-templates - -- Custom Formats
- 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 - configuration files, although these are supplementary in nature and the relevant guide profile - page should be consulted for full information. - -## Deployment - -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 - -## Customization - -:::caution - -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. - -::: - -:::caution - -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 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]. - -[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]. - -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 + ## Index diff --git a/docs/sqp-configs.md b/docs/sqp-configs.md index 3a8b1ce..0d68c46 100644 --- a/docs/sqp-configs.md +++ b/docs/sqp-configs.md @@ -5,6 +5,8 @@ sidebar_class_name: hidden hide_table_of_contents: true --- +import Session from './_configs-common.md'; + Recyclarr offers pre-built configuration files that can be used as a straightforward method of deploying one of more of the TRaSH Guides profiles: @@ -32,71 +34,7 @@ deploying one of more of the TRaSH Guides profiles: ::: -These pre-built configuration files are composed of two primary elements: - -- Includes
- [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]. - - [include-templates]: https://recyclarr.dev/wiki/yaml/config-reference/include/#template - [config-templates-repo]: https://github.com/recyclarr/config-templates - -- Custom Formats
- 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 - configuration files, although these are supplementary in nature and the relevant guide profile - page should be consulted for full information. - -## Deployment - -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 - -## Customization - -:::caution - -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. - -::: - -:::caution - -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 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]. - -[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]. - -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 + ## Index