From 105f0d4082ae241fc1479ce180d8dd70e1acce8f Mon Sep 17 00:00:00 2001 From: YozoraXCII <96386153+YozoraXCII@users.noreply.github.com> Date: Fri, 1 Dec 2023 14:28:41 +0000 Subject: [PATCH] move "Metadata Edits" to Metadata File in nav, and clean up Builders navigation --- docs/builders/overview/plex.md | 8 + docs/builders/overview/thirdparty.md | 22 +++ docs/config/settings.md | 10 +- mkdocs.yml | 252 ++++++++++++++------------- 4 files changed, 163 insertions(+), 129 deletions(-) create mode 100644 docs/builders/overview/plex.md create mode 100644 docs/builders/overview/thirdparty.md diff --git a/docs/builders/overview/plex.md b/docs/builders/overview/plex.md new file mode 100644 index 00000000..a31f5ae6 --- /dev/null +++ b/docs/builders/overview/plex.md @@ -0,0 +1,8 @@ +# Plex Builders + +The below builders are available based on metadata inside your Plex Server. + +| Name | Description | Requires Config | +|:--------------------------------------------|:----------------------------------------------------------------------------------------------|:---------------:| +| [Plex](../builders/plex.md) | Grabs items based on the metadata inside your Plex Server. | ✅ | +| [Smart](../builders/smart.md) | Creates Smart Collections based on the metadata inside your Plex Server. (Collections Only) | ✅ | diff --git a/docs/builders/overview/thirdparty.md b/docs/builders/overview/thirdparty.md new file mode 100644 index 00000000..7033c07a --- /dev/null +++ b/docs/builders/overview/thirdparty.md @@ -0,0 +1,22 @@ +# Third-Party Builders + +The below builders are available based on third-party services, multiple builders can be combined in one collection. + +| Name | Description | Requires Config | +|:---------------------------------------------|:----------------------------------------------------------------------------------------------|:---------------:| +| [TMDb](../builders/tmdb.md) | Grabs items based on metadata and lists on [TheMovieDb.org](https://www.themoviedb.org/). | ✅ | +| [TVDb](../builders/tvdb.md) | Grabs items based on metadata and lists on [TheTVDb.com](https://www.thetvdb.com/). | ❌ | +| [IMDb](../builders/imdb.md) | Grabs items based on metadata and lists on [IMDb.com](https://www.imdb.com/). | ❌ | +| [Trakt](../builders/trakt.md) | Grabs items based on metadata and lists on [Trakt.tv](https://trakt.tv/). | ✅ | +| [Tautulli](../builders/tautulli.md) | Grabs items based on metadata and lists in your [Tautulli](https://tautulli.com/). | ✅ | +| [Radarr](../builders/radarr.md) | Grabs items based on metadata and lists in your [Radarr](https://radarr.video/) . | ✅ | +| [Sonarr](../builders/sonarr.md) | Grabs items based on metadata and lists in your [Sonarr](https://sonarr.tv/). | ✅ | +| [MdbList](../builders/mdblist.md) | Grabs items based on metadata and lists on [MdbList.com](https://mdblist.com/). | ❌ | +| [Letterboxd](../builders/letterboxd.md) | Grabs items based on metadata and lists on [Letterboxd.com](https://letterboxd.com/). | ❌ | +| [ICheckMovies](../builders/icheckmovies.md) | Grabs items based on metadata and lists on [ICheckMovies.com](https://www.icheckmovies.com/). | ❌ | +| [FlixPatrol](../builders/flixpatrol.md) | Grabs items based on metadata and lists on [FlixPatrol.com](https://flixpatrol.com/). | ❌ | +| [Reciperr](../builders/reciperr.md) | Grabs items based on metadata and lists on [reciperr.com](https://reciperr.com/). | ❌ | +| [StevenLu](../builders/stevenlu.md) | Grabs items based on metadata and lists on [StevenLu.com](https://movies.stevenlu.com/). | ❌ | +| [AniDB](../builders/anidb.md) | Grabs items based on metadata and lists on [AniDB.net](https://anidb.net/). | ❌ | +| [AniList](../builders/anilist.md) | Grabs items based on metadata and lists on [AniList.co](https://anilist.co/). | ❌ | +| [MyAnimeList](../builders/myanimelist.md) | Grabs items based on metadata and lists on [MyAnimeList.net](https://myanimelist.net/). | ✅ | \ No newline at end of file diff --git a/docs/config/settings.md b/docs/config/settings.md index 0c595f13..87d6908c 100644 --- a/docs/config/settings.md +++ b/docs/config/settings.md @@ -96,8 +96,8 @@ If no library-level attribute is set, then the global attribute is used. libraries: Movies: run_order: #(1)! - - operations - metadata + - operations - overlays minimum_items: 3 #(2)! metadata_path: @@ -115,8 +115,8 @@ libraries: # stuff here settings: run_order: #(3)! - - metadata - operations + - metadata - overlays minimum_items: 1 #(4)! ``` @@ -514,17 +514,17 @@ Set `playlist_report` to true to print out a playlist report at the end of the l ## Run Order -Specify the run order of the library components [Metadata Files, Library Operations, and Overlay Files] +Specify the run order of the library components [Library Operations, Metadata Files and Overlay Files] ???+ tip - If not specified, the default run order is Metadata Files, then Library Operations, then Overlay Files + If not specified, the default run order is Library Operations, then Metadata Files, then Overlay Files ```yml settings: run_order: - - metadata - operations + - metadata - overlays ``` diff --git a/mkdocs.yml b/mkdocs.yml index d1ec0810..39462843 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -264,125 +264,133 @@ nav: - Overview: metadata/metadata.md - Templates: builders/templates.md - Filters: builders/filters.md - - Builders Overview: metadata/builders.md - - "PLEX & SMART BUILDERS": - - Plex Builders: - - Overview: builders/plex.md - - Plex All: builders/plex/#plex-all - - Plex Watchlist: builders/plex/#plex-watchlist - - Plex Pilots: builders/plex/#plex-pilots - - Plex Collectionless: builders/plex/#plex-collectionless - - Plex Search: builders/plex/#plex-search - - "Smart Builders": - - Overview: builders/smart.md - - Smart Label: builders/smart/#smart-label - - Smart Filter: builders/smart/#smart-filter - - "THIRD-PARTY BUILDERS": - - TMDb Builders: - - Overview: builders/tmdb.md - - TMDb Collection: builders/tmdb/#tmdb-collection - - TMDb List: builders/tmdb/#tmdb-list - - TMDb Actor: builders/tmdb/#tmdb-actor - - TMDb Crew: builders/tmdb/#tmdb-crew - - TMDb Director: builders/tmdb/#tmdb-director - - TMDb Producer: builders/tmdb/#tmdb-producer - - TMDb Writer: builders/tmdb/#tmdb-writer - - TMDb Movie: builders/tmdb/#tmdb-movie - - TMDb Show: builders/tmdb/#tmdb-show - - TMDb Company: builders/tmdb/#tmdb-company - - TMDb Network: builders/tmdb/#tmdb-network - - TMDb Keyword: builders/tmdb/#tmdb-keyword - - TMDb Popular: builders/tmdb/#tmdb-popular - - TMDb Now Playing: builders/tmdb/#tmdb-now-playing - - TMDb Top Rated: builders/tmdb/#tmdb-top-rated - - TMDb Upcoming: builders/tmdb/#tmdb-upcoming - - TMDb Airing Today: builders/tmdb/#tmdb-airing-today - - TMDb On the Air: builders/tmdb/#tmdb-on-the-air - - TMDb Trending Daily: builders/tmdb/#tmdb-trending-daily - - TMDb Trending Weekly: builders/tmdb/#tmdb-trending-weekly - - TMDb Discover: builders/tmdb/#tmdb-discover - - TVDb Builders: - - Overview: builders/tvdb.md - - TVDb List: builders/tvdb/#tvdb-list - - TVDb Movie: builders/tvdb/#tvdb-movie - - TVDb Show: builders/tvdb/#tvdb-show - - IMDb Builders: - - Overview: builders/imdb.md - - IMDb ID: builders/imdb/#imdb-id - - IMDb Chart: builders/imdb/#imdb-chart - - IMDb List: builders/imdb/#imdb-list - - IMDb Watchlist: builders/imdb/#imdb-watchlist - - Trakt Builders: - - Overview: builders/trakt.md - - Trakt List: builders/trakt/#trakt-list - - Trakt Chart: builders/trakt/#trakt-chart - - Trakt Userlist: builders/trakt/#trakt-userlist - - Trakt Recommendations: builders/trakt/#trakt-recommendations - - Trakt Box Office: builders/trakt/#trakt-box-office - - Tautulli Builders: - - Overview: builders/tautulli.md - - Tautulli Popular/Watched: builders/tautulli/#tautulli-popular-watched - - Radarr Builders: - - Overview: builders/radarr.md - - Radarr All: builders/radarr/#radarr-all - - Radarr Taglist: builders/radarr/#radarr-taglist - - Sonarr Builders: - - Overview: builders/sonarr.md - - Sonarr All: builders/sonarr/#sonarr-all - - Sonarr Taglist: builders/sonarr/#sonarr-taglist - - MdbList Builders: - - Overview: builders/mdblist.md - - MdbList List: builders/mdblist/#mdblist-list - - Letterboxd Builders: - - Overview: builders/letterboxd.md - - Letterboxd List: builders/letterboxd/#letterboxd-list - - ICheckMovies Builders: - - Overview: builders/icheckmovies.md - - ICheckMovies List: builders/icheckmovies/#icheckmovies-list - - FlixPatrol Builders: - - Overview: builders/flixpatrol.md - - FlixPatrol Top Platform: builders/flixpatrol/#flixpatrol-top - - FlixPatrol Popular: builders/flixpatrol/#flixpatrol-popular - - FlixPatrol Demographics: builders/flixpatrol/#flixpatrol-demographics - - FlixPatrol URL: builders/flixpatrol/#flixpatrol-url - - Reciperr Builders: - - Overview: builders/reciperr.md - - Reciperr List: builders/reciperr/#reciperr-list - - StevenLu Builders: - - Overview: builders/stevenlu.md - - StevenLu List: builders/stevenlu/#stevenlu-s-popular-movies-list - - AniDB Builders: - - Overview: builders/anidb.md - - AniDB ID: builders/anidb/#anidb-id - - AniDB Relation: builders/anidb/#anidb-relation - - AniDB Popular: builders/anidb/#anidb-popular - - AniDB Tag: builders/anidb/#anidb-tag - - AniList Builders: - - Overview: builders/anilist.md - - AniList Top Rated: builders/anilist/#anilist-top-rated - - AniList Anilist Popular: builders/anilist/#anilist-anilist-popular - - AniList Trending: builders/anilist/#anilist-trending - - AniList Relations: builders/anilist/#anilist-relations - - AniList Studio: builders/anilist/#anilist-studio - - AniList ID: builders/anilist/#anilist-id - - AniList UserList: builders/anilist/#anilist-userlist - - AniList Search: builders/anilist/#anilist-search - - MyAnimeList Builders: - - Overview: builders/myanimelist.md - - MyAnimeList Search: builders/myanimelist/#myanimelist-search - - MyAnimeList Top All: builders/myanimelist/#myanimelist-top-all - - MyAnimeList Top Airing: builders/myanimelist/#myanimelist-top-airing - - MyAnimeList Top Upcoming: builders/myanimelist/#myanimelist-top-upcoming - - MyAnimeList Top TV Series: builders/myanimelist/#myanimelist-top-tv-series - - MyAnimeList Top Movies: builders/myanimelist/#myanimelist-top-movies - - MyAnimeList Top OVA Series: builders/myanimelist/#myanimelist-top-ova-series - - MyAnimeList Top Specials: builders/myanimelist/#myanimelist-top-specials - - MyAnimeList Most Popular: builders/myanimelist/#myanimelist-most-popular - - MyAnimeList Most Favorited: builders/myanimelist/#myanimelist-most-favorited - - MyAnimeList Suggested: builders/myanimelist/#myanimelist-suggested - - MyAnimeList ID: builders/myanimelist/#myanimelist-id - - MyAnimeList UserList: builders/myanimelist/#myanimelist-userlist - - MyAnimeList Seasonal: builders/myanimelist/#myanimelist-seasonal + - "EDITING METADATA": + - Metadata Edits: + - Movie Metadata Edits: metadata/metadata/movie.md + - Show Metadata Edits: metadata/metadata/show.md + - Music Metadata: metadata/metadata/music.md + - "BUILDERS": + - Overview: metadata/builders.md + - "Plex Builders": + - Overview: builders/overview/plex.md + - Plex Builders: + - Overview: builders/plex.md + - Plex All: builders/plex/#plex-all + - Plex Watchlist: builders/plex/#plex-watchlist + - Plex Pilots: builders/plex/#plex-pilots + - Plex Collectionless: builders/plex/#plex-collectionless + - Plex Search: builders/plex/#plex-search + - "Smart Builders": + - Overview: builders/smart.md + - Smart Label: builders/smart/#smart-label + - Smart Filter: builders/smart/#smart-filter + - "Third-Party Builders": + - Overview: builders/overview/thirdparty.md + - TMDb Builders: + - Overview: builders/tmdb.md + - TMDb Collection: builders/tmdb/#tmdb-collection + - TMDb List: builders/tmdb/#tmdb-list + - TMDb Actor: builders/tmdb/#tmdb-actor + - TMDb Crew: builders/tmdb/#tmdb-crew + - TMDb Director: builders/tmdb/#tmdb-director + - TMDb Producer: builders/tmdb/#tmdb-producer + - TMDb Writer: builders/tmdb/#tmdb-writer + - TMDb Movie: builders/tmdb/#tmdb-movie + - TMDb Show: builders/tmdb/#tmdb-show + - TMDb Company: builders/tmdb/#tmdb-company + - TMDb Network: builders/tmdb/#tmdb-network + - TMDb Keyword: builders/tmdb/#tmdb-keyword + - TMDb Popular: builders/tmdb/#tmdb-popular + - TMDb Now Playing: builders/tmdb/#tmdb-now-playing + - TMDb Top Rated: builders/tmdb/#tmdb-top-rated + - TMDb Upcoming: builders/tmdb/#tmdb-upcoming + - TMDb Airing Today: builders/tmdb/#tmdb-airing-today + - TMDb On the Air: builders/tmdb/#tmdb-on-the-air + - TMDb Trending Daily: builders/tmdb/#tmdb-trending-daily + - TMDb Trending Weekly: builders/tmdb/#tmdb-trending-weekly + - TMDb Discover: builders/tmdb/#tmdb-discover + - TVDb Builders: + - Overview: builders/tvdb.md + - TVDb List: builders/tvdb/#tvdb-list + - TVDb Movie: builders/tvdb/#tvdb-movie + - TVDb Show: builders/tvdb/#tvdb-show + - IMDb Builders: + - Overview: builders/imdb.md + - IMDb ID: builders/imdb/#imdb-id + - IMDb Chart: builders/imdb/#imdb-chart + - IMDb List: builders/imdb/#imdb-list + - IMDb Watchlist: builders/imdb/#imdb-watchlist + - Trakt Builders: + - Overview: builders/trakt.md + - Trakt List: builders/trakt/#trakt-list + - Trakt Chart: builders/trakt/#trakt-chart + - Trakt Userlist: builders/trakt/#trakt-userlist + - Trakt Recommendations: builders/trakt/#trakt-recommendations + - Trakt Box Office: builders/trakt/#trakt-box-office + - Tautulli Builders: + - Overview: builders/tautulli.md + - Tautulli Popular/Watched: builders/tautulli/#tautulli-popular-watched + - Radarr Builders: + - Overview: builders/radarr.md + - Radarr All: builders/radarr/#radarr-all + - Radarr Taglist: builders/radarr/#radarr-taglist + - Sonarr Builders: + - Overview: builders/sonarr.md + - Sonarr All: builders/sonarr/#sonarr-all + - Sonarr Taglist: builders/sonarr/#sonarr-taglist + - MdbList Builders: + - Overview: builders/mdblist.md + - MdbList List: builders/mdblist/#mdblist-list + - Letterboxd Builders: + - Overview: builders/letterboxd.md + - Letterboxd List: builders/letterboxd/#letterboxd-list + - ICheckMovies Builders: + - Overview: builders/icheckmovies.md + - ICheckMovies List: builders/icheckmovies/#icheckmovies-list + - FlixPatrol Builders: + - Overview: builders/flixpatrol.md + - FlixPatrol Top Platform: builders/flixpatrol/#flixpatrol-top + - FlixPatrol Popular: builders/flixpatrol/#flixpatrol-popular + - FlixPatrol Demographics: builders/flixpatrol/#flixpatrol-demographics + - FlixPatrol URL: builders/flixpatrol/#flixpatrol-url + - Reciperr Builders: + - Overview: builders/reciperr.md + - Reciperr List: builders/reciperr/#reciperr-list + - StevenLu Builders: + - Overview: builders/stevenlu.md + - StevenLu List: builders/stevenlu/#stevenlu-s-popular-movies-list + - AniDB Builders: + - Overview: builders/anidb.md + - AniDB ID: builders/anidb/#anidb-id + - AniDB Relation: builders/anidb/#anidb-relation + - AniDB Popular: builders/anidb/#anidb-popular + - AniDB Tag: builders/anidb/#anidb-tag + - AniList Builders: + - Overview: builders/anilist.md + - AniList Top Rated: builders/anilist/#anilist-top-rated + - AniList Anilist Popular: builders/anilist/#anilist-anilist-popular + - AniList Trending: builders/anilist/#anilist-trending + - AniList Relations: builders/anilist/#anilist-relations + - AniList Studio: builders/anilist/#anilist-studio + - AniList ID: builders/anilist/#anilist-id + - AniList UserList: builders/anilist/#anilist-userlist + - AniList Search: builders/anilist/#anilist-search + - MyAnimeList Builders: + - Overview: builders/myanimelist.md + - MyAnimeList Search: builders/myanimelist/#myanimelist-search + - MyAnimeList Top All: builders/myanimelist/#myanimelist-top-all + - MyAnimeList Top Airing: builders/myanimelist/#myanimelist-top-airing + - MyAnimeList Top Upcoming: builders/myanimelist/#myanimelist-top-upcoming + - MyAnimeList Top TV Series: builders/myanimelist/#myanimelist-top-tv-series + - MyAnimeList Top Movies: builders/myanimelist/#myanimelist-top-movies + - MyAnimeList Top OVA Series: builders/myanimelist/#myanimelist-top-ova-series + - MyAnimeList Top Specials: builders/myanimelist/#myanimelist-top-specials + - MyAnimeList Most Popular: builders/myanimelist/#myanimelist-most-popular + - MyAnimeList Most Favorited: builders/myanimelist/#myanimelist-most-favorited + - MyAnimeList Suggested: builders/myanimelist/#myanimelist-suggested + - MyAnimeList ID: builders/myanimelist/#myanimelist-id + - MyAnimeList UserList: builders/myanimelist/#myanimelist-userlist + - MyAnimeList Seasonal: builders/myanimelist/#myanimelist-seasonal - DYNAMIC COLLECTIONS: - Overview: metadata/dynamic.md - TMDb Dynamic Collections: @@ -429,17 +437,13 @@ nav: - Collection/Playlist Metadata Updates: builders/details/metadata.md - Item Metadata Updates: builders/details/item_metadata.md - MISCELLANEOUS: - - EDITING METADATA: - - Editing Movie Metadata: metadata/metadata/movie.md - - Editing TV Metadata: metadata/metadata/show.md - - Editing Music Metadata: metadata/metadata/music.md - - Formula 1 Metadata Guide: pmm/install/guides/formula.md - EXPLANATION GUIDES: - Plex Ratings Explained: pmm/essentials/ratings.md - Scheduling Guide: pmm/install/guides/scheduling.md - Image Asset Directory Guide: pmm/install/guides/assets.md - Log Files: pmm/essentials/logs.md - YAML File Guide: pmm/essentials/yaml.md + - Formula 1 Metadata Guide: pmm/install/guides/formula.md - COMPANION SCRIPTS: - Overview: pmm/essentials/scripts.md - Plex Image Cleanup: pmm/essentials/scripts/image-cleanup.md