e1f81e5274
* docs(config): Clarify preset ordering priority Refs #1276 * docs(architecture): WIP Narrative how it works Much of this is repetition of the reference docs and some of the changes here should also be applied here. The goal is to repeat here the parts of the reference docs that may hang up a user when reading "Getting Started" without sending them off to get lost in the weeds of the reference docs. Note that this references a `Quick Start` document which is just an empty placeholder and is to be written in a subsequent change. Fixes #1279 * docs(terms): Glossary redundant with architecture Now that the introduction includes an architectural overview, that section introduces new users to necessary concepts and associated terminology and makes the terminology section redundant in that part of the docs. * docs(quick): Add a rote quick start guide This is what I came up with when I tried to write instructions requiring as little understanding as possible. Doing so really did reinforce my impression that this just shouldn't be done, that significant understanding is required for *any* use of ytdl-sub and even offering a quick start may be irresponsible. I'm still on the fence, thoughts? That said, I also think I got some good explanations out of this and a better understanding of what the next bits of the Getting Started should be. This Quick Start is currently redundant with other parts of the Getting Started pages. I suspect that I'll end up repeating and/or reorganizing parts of this Quick Start into the next bits of the Getting Started. To that end I might argue that this change is a WIP and that merging should wait. But I could also argue that this is an incremental improvement and can be merged before that other work. Your call. * docs(start): Various rST/Sphinx markup issues
88 lines
3 KiB
YAML
88 lines
3 KiB
YAML
# subscriptions.yaml:
|
|
# Everything in here can be downloaded using the command:
|
|
# ytdl-sub sub subscriptions.yaml
|
|
|
|
# __preset__ is a place to define global overrides for all subscriptions
|
|
__preset__:
|
|
overrides:
|
|
# Root folder of all ytdl-sub TV Shows
|
|
tv_show_directory: "/tv_shows"
|
|
|
|
# Root folder of all ytdl-sub Music
|
|
music_directory: "/music"
|
|
|
|
# Root folder of all ytdl-sub Music Videos
|
|
music_video_directory: "/music_videos"
|
|
|
|
# For 'Only Recent' preset, only keep vids within this range and limit
|
|
# only_recent_date_range: "2months"
|
|
# only_recent_max_files: 30
|
|
|
|
# Pass any arg directly to yt-dlp's Python API
|
|
# ytdl_options:
|
|
# cookiefile: "/config/cookie.txt"
|
|
|
|
###################################################################
|
|
# Subscriptions nested under this will use the
|
|
# `Plex TV Show by Date` preset.
|
|
#
|
|
# Can choose between:
|
|
# - Plex TV Show by Date:
|
|
# - Jellyfin TV Show by Date:
|
|
# - Kodi TV Show by Date:
|
|
Plex TV Show by Date:
|
|
|
|
# Sets genre tag to "Documentaries"
|
|
= Documentaries:
|
|
"NOVA PBS": "https://www.youtube.com/@novapbs"
|
|
# "National Geographic": "https://www.youtube.com/@NatGeo"
|
|
# "Cosmos - What If": "https://www.youtube.com/playlist?list=PLZdXRHYAVxTJno6oFF9nLGuwXNGYHmE8U"
|
|
|
|
# Sets genre tag to "Kids", "TV-Y" for content rating
|
|
# = Kids | = TV-Y:
|
|
# "Jake Trains": "https://www.youtube.com/@JakeTrains"
|
|
# "Kids Toys Play": "https://www.youtube.com/@KidsToysPlayChannel"
|
|
|
|
# = Music:
|
|
# # TV show subscriptions can support multiple urls and store in the same TV Show
|
|
# "Rick Beato":
|
|
# - "https://www.youtube.com/@RickBeato"
|
|
# - "https://www.youtube.com/@rickbeato240"
|
|
|
|
# Set genre tag to "News", use `Only Recent` preset to only store videos uploaded recently
|
|
# = News | Only Recent:
|
|
# "BBC News": "https://www.youtube.com/@BBCNews"
|
|
|
|
###################################################################
|
|
# Subscriptions nested under these will use the various prebuilt
|
|
# music presets
|
|
|
|
# YouTube Releases:
|
|
# = Jazz: # Sets genre tag to "Jazz"
|
|
# "Thelonious Monk": "https://www.youtube.com/@theloniousmonk3870/releases"
|
|
|
|
# YouTube Full Albums:
|
|
# = Lofi:
|
|
# "Game Chops": "https://www.youtube.com/playlist?list=PLBsm_SagFMmdWnCnrNtLjA9kzfrRkto4i"
|
|
|
|
# SoundCloud Discography:
|
|
# = Chill Hop:
|
|
# "UKNOWY": "https://soundcloud.com/uknowymunich"
|
|
# = Synthwave:
|
|
# "Lazerdiscs Records": "https://soundcloud.com/lazerdiscsrecords"
|
|
# "Earmake": "https://soundcloud.com/earmake"
|
|
|
|
# Bandcamp:
|
|
# = Lofi:
|
|
# "Emily Hopkins": "https://emilyharpist.bandcamp.com/"
|
|
|
|
###################################################################
|
|
# Can choose between:
|
|
# - Plex Music Videos:
|
|
# - Jellyfin Music Videos:
|
|
# - Kodi Music Videos:
|
|
|
|
# "Plex Music Videos":
|
|
# = Pop: # Sets genre tag to "Pop"
|
|
# "Rick Astley": "https://www.youtube.com/playlist?list=PLlaN88a7y2_plecYoJxvRFTLHVbIVAOoc"
|
|
# "Michael Jackson": "https://www.youtube.com/playlist?list=OLAK5uy_mnY03zP6abNWH929q2XhGzWD_2uKJ_n8E"
|