open-source-guides
/
TRaSH-Guides
mirror of https://github.com/TRaSH-/Guides
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '083d1c3f53'
${ noResults }
TRaSH-Guides/metadata.json

24 lines
771 B
Raw Normal View History Unescape

chore: New metadata.json file with repo information Currently, tooling that references files in the Trash Guides github repository has no reliable way to know where certain information lives. For example, the Recyclarr application hard-codes paths (relative to the repo root) to find the location of certain JSON files for Sonarr and Radarr. Hard-coding paths is a poor practice because it limits the ability for the Guides repository to be reorganized without breaking tools. This commit introduces a file named `metadata.json` that exists at the root of the repository. Its sole purpose is to communicate information about the repository itself. For now, the only thing this file provides is the paths to JSON files for Radarr custom formats and Sonarr release profiles. This file will never move, otherwise we run into the same issue that existed prior to having this file. When relevant files or directories are reorganized in the repository, respective paths in `metadata.json` will be updated which will allow tooling to continue to find needed resources. The catalyst for this change is that there has been discussion recently about a new structure for JSON files in the repository due to the introduction of Sonarr v4 JSON files. Lastly, a schema has been provided to assist with live editing in `metadata.json`. The schema file is named `metadata.schema.json`. Some editors provide validation as you edit JSON files (e.g. VS Code), which will take advantage of this Fixes #703
2 years ago
{
"$schema": "metadata.schema.json",
"json_paths": {
"radarr": {
chore(metadata): Add paths for quality definition data
2 years ago
"custom_formats": ["docs/json/radarr/cf"],
Updated: metadata
2 years ago
"qualities": ["docs/json/radarr/quality-size"],
feat(backend): Add Quality Profile JSON Files for Use by Guide Sync Tools (#1660) * Add initial quality profile JSON files for Radarr These files were auto-generated by an exporter tool provided by nitsua. The source of the exported data was one of Trash's Radarr instances. The following transformations were performed on the data model provided by Radarr. All of these are motivated by providing a simpler JSON file schema for guide contributors and eliminating redundant data. - Any `id` fields are omitted (for `items` especially) since those can vary from instance to instance. - The `formatItems` array represents a mapping of Custom Format Name to Custom Format Trash ID. The name itself is for documentation purposes only and serves no functional purpose; think of it as a comment that exists only to describe the CF identified by the trash ID next to it. The Trash ID itself is self explanatory; that is used by tooling to identify the CF JSON file paired with the quality profile. - Greatly simplified the `items` structure (this is the list of qualities and/or groups). The following rules must be adhered to: - The `allowed` property is required. It must be either true or false. This corresponds to the enabled/disabled toggle in the Radarr UI. - For qualities, `name` must match an existing quality *exactly, including case*. For groups, `name` can be whatever you want as long as it is unique. - For groups, a nested `items` array may be provided which identifies **two or more** quality names within it. - All qualities must be present and none omitted, even if their `allowed` property is set to `false`. This ensures explicit ordering in the guides. * Add quality profile groups to metadata.json Initially only for Radarr * Radarr JSON Updates - Renamed HD Bluray + WEB and UHD Bluray + WEB profile JSONs to be consistent with the profile names - Added Custom Format Group JSONs for: - Advanced Audio Formats - Optional Custom Formats - Fixes and updates for quality profile JSONs: - Removed non-mandatory custom formats - Removed incorrect custom formats - Fixed incorrect minimum profile scores for SQP-2/3/4/5 - Renamed merged quality group for SQP-5 - Reordered custom formats to match respective guide pages * Sonarr Profiles and Other Updates - Created quality profile JSONs for Sonarr - Created Optional CF group JSON for Sonarr - Created HDR Formats CF group JSONs for Radarr and Sonarr - Created Advanced Audio Formats CF group JSON for Sonarr - Added `trash_score_sets` to relevant quality profile JSONs - Fixed incorrect `required` variable inn Radarr Optional CF group JSON * Create Optional UHD Groups - Create new JSONs for Optional UHD custom format groups - Amend existing Optional custom format group JSONs to exclude relevant UHD profiles * Add DV HDR10Plus Custom Formats - Add DV HDR10Plus custom formats to relevant profile and group JSONs. * Add Sonarr QPs and CF Groups to metadata.json * Radarr Updates - Updated all jsons to match latest guide updates - Swapped `x265 (HD)` and `x265 (no HDR/DV)` for all UHD-capable profiles. This makes `x265 (no HDR/DV)` mandatory and `x265 (HD)` optional * Sonarr Updates - Update jsons with latest guide profile updates - Swapped `x265 (HD)` and `x265 (no HDR/DV)` for WEB-2160p profile. This makes `x265 (no HDR/DV)` mandatory and `x265 (HD)` optional * Radarr Quality Profile Updates 2024-04-22 - Updated Radarr quality profile JSONs to match current profile state * Sonarr Quality Profile Updates 2024-04-22 - Updated Sonarr quality profile JSONs to match current profile state --------- Co-authored-by: yammes08 <111231042+yammes08@users.noreply.github.com>
7 months ago
"naming": ["docs/json/radarr/naming"],
"quality_profiles": ["docs/json/radarr/quality-profiles"],
"custom_format_groups": ["docs/json/radarr/cf-groups"]
chore: New metadata.json file with repo information Currently, tooling that references files in the Trash Guides github repository has no reliable way to know where certain information lives. For example, the Recyclarr application hard-codes paths (relative to the repo root) to find the location of certain JSON files for Sonarr and Radarr. Hard-coding paths is a poor practice because it limits the ability for the Guides repository to be reorganized without breaking tools. This commit introduces a file named `metadata.json` that exists at the root of the repository. Its sole purpose is to communicate information about the repository itself. For now, the only thing this file provides is the paths to JSON files for Radarr custom formats and Sonarr release profiles. This file will never move, otherwise we run into the same issue that existed prior to having this file. When relevant files or directories are reorganized in the repository, respective paths in `metadata.json` will be updated which will allow tooling to continue to find needed resources. The catalyst for this change is that there has been discussion recently about a new structure for JSON files in the repository due to the introduction of Sonarr v4 JSON files. Lastly, a schema has been provided to assist with live editing in `metadata.json`. The schema file is named `metadata.schema.json`. Some editors provide validation as you edit JSON files (e.g. VS Code), which will take advantage of this Fixes #703
2 years ago
},
"sonarr": {
undo markdown changes to split PR
2 years ago
"release_profiles": ["docs/json/sonarr/rp"],
chore(metadata): Add paths for quality definition data
2 years ago
"custom_formats": ["docs/json/sonarr/cf"],
Updated: metadata
2 years ago
"qualities": ["docs/json/sonarr/quality-size"],
feat(backend): Add Quality Profile JSON Files for Use by Guide Sync Tools (#1660) * Add initial quality profile JSON files for Radarr These files were auto-generated by an exporter tool provided by nitsua. The source of the exported data was one of Trash's Radarr instances. The following transformations were performed on the data model provided by Radarr. All of these are motivated by providing a simpler JSON file schema for guide contributors and eliminating redundant data. - Any `id` fields are omitted (for `items` especially) since those can vary from instance to instance. - The `formatItems` array represents a mapping of Custom Format Name to Custom Format Trash ID. The name itself is for documentation purposes only and serves no functional purpose; think of it as a comment that exists only to describe the CF identified by the trash ID next to it. The Trash ID itself is self explanatory; that is used by tooling to identify the CF JSON file paired with the quality profile. - Greatly simplified the `items` structure (this is the list of qualities and/or groups). The following rules must be adhered to: - The `allowed` property is required. It must be either true or false. This corresponds to the enabled/disabled toggle in the Radarr UI. - For qualities, `name` must match an existing quality *exactly, including case*. For groups, `name` can be whatever you want as long as it is unique. - For groups, a nested `items` array may be provided which identifies **two or more** quality names within it. - All qualities must be present and none omitted, even if their `allowed` property is set to `false`. This ensures explicit ordering in the guides. * Add quality profile groups to metadata.json Initially only for Radarr * Radarr JSON Updates - Renamed HD Bluray + WEB and UHD Bluray + WEB profile JSONs to be consistent with the profile names - Added Custom Format Group JSONs for: - Advanced Audio Formats - Optional Custom Formats - Fixes and updates for quality profile JSONs: - Removed non-mandatory custom formats - Removed incorrect custom formats - Fixed incorrect minimum profile scores for SQP-2/3/4/5 - Renamed merged quality group for SQP-5 - Reordered custom formats to match respective guide pages * Sonarr Profiles and Other Updates - Created quality profile JSONs for Sonarr - Created Optional CF group JSON for Sonarr - Created HDR Formats CF group JSONs for Radarr and Sonarr - Created Advanced Audio Formats CF group JSON for Sonarr - Added `trash_score_sets` to relevant quality profile JSONs - Fixed incorrect `required` variable inn Radarr Optional CF group JSON * Create Optional UHD Groups - Create new JSONs for Optional UHD custom format groups - Amend existing Optional custom format group JSONs to exclude relevant UHD profiles * Add DV HDR10Plus Custom Formats - Add DV HDR10Plus custom formats to relevant profile and group JSONs. * Add Sonarr QPs and CF Groups to metadata.json * Radarr Updates - Updated all jsons to match latest guide updates - Swapped `x265 (HD)` and `x265 (no HDR/DV)` for all UHD-capable profiles. This makes `x265 (no HDR/DV)` mandatory and `x265 (HD)` optional * Sonarr Updates - Update jsons with latest guide profile updates - Swapped `x265 (HD)` and `x265 (no HDR/DV)` for WEB-2160p profile. This makes `x265 (no HDR/DV)` mandatory and `x265 (HD)` optional * Radarr Quality Profile Updates 2024-04-22 - Updated Radarr quality profile JSONs to match current profile state * Sonarr Quality Profile Updates 2024-04-22 - Updated Sonarr quality profile JSONs to match current profile state --------- Co-authored-by: yammes08 <111231042+yammes08@users.noreply.github.com>
7 months ago
"naming": ["docs/json/sonarr/naming"],
"quality_profiles": ["docs/json/sonarr/quality-profiles"],
"custom_format_groups": ["docs/json/sonarr/cf-groups"]
chore: New metadata.json file with repo information Currently, tooling that references files in the Trash Guides github repository has no reliable way to know where certain information lives. For example, the Recyclarr application hard-codes paths (relative to the repo root) to find the location of certain JSON files for Sonarr and Radarr. Hard-coding paths is a poor practice because it limits the ability for the Guides repository to be reorganized without breaking tools. This commit introduces a file named `metadata.json` that exists at the root of the repository. Its sole purpose is to communicate information about the repository itself. For now, the only thing this file provides is the paths to JSON files for Radarr custom formats and Sonarr release profiles. This file will never move, otherwise we run into the same issue that existed prior to having this file. When relevant files or directories are reorganized in the repository, respective paths in `metadata.json` will be updated which will allow tooling to continue to find needed resources. The catalyst for this change is that there has been discussion recently about a new structure for JSON files in the repository due to the introduction of Sonarr v4 JSON files. Lastly, a schema has been provided to assist with live editing in `metadata.json`. The schema file is named `metadata.schema.json`. Some editors provide validation as you edit JSON files (e.g. VS Code), which will take advantage of this Fixes #703
2 years ago
}
Move recyclarr property up a level The `recyclarr` property was under `json_paths` which isn't appropriate for a few reasons: 1. `json_paths` is expected to be for guide-only data (like custom formats). 2. The recyclarr path at the moment is to YAML files, not JSON files.
2 years ago
},
"recyclarr": {
"templates": "docs/recyclarr-configs"
chore: New metadata.json file with repo information Currently, tooling that references files in the Trash Guides github repository has no reliable way to know where certain information lives. For example, the Recyclarr application hard-codes paths (relative to the repo root) to find the location of certain JSON files for Sonarr and Radarr. Hard-coding paths is a poor practice because it limits the ability for the Guides repository to be reorganized without breaking tools. This commit introduces a file named `metadata.json` that exists at the root of the repository. Its sole purpose is to communicate information about the repository itself. For now, the only thing this file provides is the paths to JSON files for Radarr custom formats and Sonarr release profiles. This file will never move, otherwise we run into the same issue that existed prior to having this file. When relevant files or directories are reorganized in the repository, respective paths in `metadata.json` will be updated which will allow tooling to continue to find needed resources. The catalyst for this change is that there has been discussion recently about a new structure for JSON files in the repository due to the introduction of Sonarr v4 JSON files. Lastly, a schema has been provided to assist with live editing in `metadata.json`. The schema file is named `metadata.schema.json`. Some editors provide validation as you edit JSON files (e.g. VS Code), which will take advantage of this Fixes #703
2 years ago
}
}