From 2a79a50d5028d006e648829bcef9a8fcb0bea035 Mon Sep 17 00:00:00 2001 From: Robert Dailey Date: Sat, 26 Nov 2022 09:41:06 -0600 Subject: [PATCH] fix: Address multiple issues with the config template - Simplify the comment style for YAML intended to be uncommented by the user. Now they just need to delete the leading hash and YAML will be at the appropriate indentation. - Add additional explanation at the top about how to set up configuration based on the guide. - Fix link to the configuration reference. --- CHANGELOG.md | 2 ++ src/Recyclarr/config-template.yml | 25 +++++++++++++++---------- 2 files changed, 17 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4150e7d2..b0d6965e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -41,6 +41,8 @@ the executable has been removed. ### Fixed - Sonarr: Run validation on Custom Formats configuration, if specified, to check for errors. +- Added more instructions, fixed broken links, and simplified the way you uncomment optional parts + of the YAML in the starter `recyclarr.yml` template generated by the `create-config` subcommand. [breaking3]: https://recyclarr.dev/wiki/upgrade-guide/upgrade-guide-v3.0 [yaml-config]: https://recyclarr.dev/wiki/file-structure#directory-configs diff --git a/src/Recyclarr/config-template.yml b/src/Recyclarr/config-template.yml index 2dbc62b4..f65b35ad 100644 --- a/src/Recyclarr/config-template.yml +++ b/src/Recyclarr/config-template.yml @@ -4,10 +4,15 @@ # values below as needed for your instance. You will be required to update the API Key and URL for # each instance you want to use. # -# Many optional settings have been omitted to keep this template simple. +# Many optional settings have been omitted to keep this template simple. Note that there's no "one +# size fits all" configuration. Please refer to the guide to understand how to build the appropriate +# configuration based on your hardware setup and capabilities. +# +# For any lines that mention uncommenting YAML, you simply need to remove the leading hash (`#`). +# The YAML comments will already be at the appropriate indentation. # # For more details on the configuration, see the Configuration Reference on the wiki here: -# https://github.com/recyclarr/recyclarr/wiki/Configuration-Reference +# https://recyclarr.dev/wiki/reference/config-reference # Configuration specific to Sonarr sonarr: @@ -27,9 +32,9 @@ sonarr: - 1B018E0C53EC825085DD911102E2CA36 # Release Sources (Streaming Service) - 71899E6C303A07AF0E4746EFF9873532 # P2P Groups + Repack/Proper # Anime (Uncomment below if you want it) -# - trash_ids: -# - d428eda85af1df8904b4bbe4fc2f537c # Anime - First release profile -# - 6cd9e10bb5bb4c63d2d7cd3279924c7b # Anime - Second release profile + #- trash_ids: + # - d428eda85af1df8904b4bbe4fc2f537c # Anime - First release profile + # - 6cd9e10bb5bb4c63d2d7cd3279924c7b # Anime - Second release profile # Configuration specific to Radarr. radarr: @@ -57,8 +62,8 @@ radarr: # Uncomment the below properties to specify one or more quality profiles that should be # updated with scores from the guide for each custom format. Without this, custom formats # are synced to Radarr but no scores are set in any quality profiles. -# quality_profiles: -# - name: Quality Profile 1 -# - name: Quality Profile 2 -# #score: -9999 # Optional score to assign to all CFs. Overrides scores in the guide. -# #reset_unmatched_scores: true # Optionally set other scores to 0 if they are not listed in 'names' above. + #quality_profiles: + # - name: Quality Profile 1 + # - name: Quality Profile 2 + # #score: -9999 # Optional score to assign to all CFs. Overrides scores in the guide. + # #reset_unmatched_scores: true # Optionally set other scores to 0 if they are not listed in 'names' above.