From 2b349ee8855db84f1c752ea4e6defcc59ea8580b Mon Sep 17 00:00:00 2001 From: meisnate12 Date: Thu, 18 Jan 2024 13:01:21 -0500 Subject: [PATCH] [13] small doc updates --- CHANGELOG | 2 ++ VERSION | 2 +- docs/config/auth.md | 29 ++++++++++++++++++++++++++++- mkdocs.yml | 1 + 4 files changed, 32 insertions(+), 2 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index a2fd83a6..1a884e36 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -5,7 +5,9 @@ Updated gitpython requirement to 3.1.41 # New Features # Updates +Added new [BoxOfficeMojo Builder](https://metamanager.wiki/en/latest/files/builders/mojo/) - credit to @nwithan8 for the suggestion and initial code submission Added new [`trakt_chart` attributes](https://metamanager.wiki/en/latest/files/builders/trakt/#trakt-chart) `network_ids`, `studio_ids`, `votes`, `tmdb_ratings`, `tmdb_votes`, `imdb_ratings`, `imdb_votes`, `rt_meters`, `rt_user_meters`, `metascores` and removed the deprecated `network` attribute +Added [Trakt and MyAnimeList Authentication Page](https://metamanager.wiki/en/latest/config/auth/) allowing users to authenticate against those services directly from the wiki. credit to @chazlarson for developing the script # Defaults diff --git a/VERSION b/VERSION index f344a443..1cbad898 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.20.0-develop12 +1.20.0-develop13 diff --git a/docs/config/auth.md b/docs/config/auth.md index 0adab8ef..c71a612a 100644 --- a/docs/config/auth.md +++ b/docs/config/auth.md @@ -1,3 +1,30 @@ # Trakt and MyAnimeList Authentication - \ No newline at end of file +When trying to authorize Trakt or MyAnimeList, PMM needs to run in interactive mode so that you can enter details. This is problematic on some setups [namely docker] where entering interactive mode is not always simple. + +These scripts allow you to authorize Trakt and MyAnimeList here on the wiki. Once authorized, the script will give you a YAML block that you will copy into the config.yml, replacing the existing `trakt` and/or `myanimelist` sections. + +The source code for these scripts can be found on [Chazlarson's GitHub Repository](https://github.com/chazlarson/PMM_Auth) +## Usage + +1. Enter client ID and secret. +2. For Trakt, if you didn't retrieve a PIN yourself less than ten minutes ago, click the button, and enter the PIN in the field. +3. For MyAnimeList, click the button to authenticate and get the required "localhost URL" +4. Click "Submit" +5. Copy and paste the result into your PMM config. + + + +## Running the Authentication Scripts Locally + +For users who want full control over the scripts and would prefer the run them locally, you can run the script in docker or python by downloading the scripts from [Chazlarson's GitHub Repository](https://github.com/chazlarson/PMM_Auth) + +??? abstract "Click for instructions on how to run the scripts locally" + + Ensure you have downloaded a copy of the script from [Chazlarson's GitHub Repository](https://github.com/chazlarson/PMM_Auth). If you have downloaded the ZIP, extract it to your desired location. + + {% + include-markdown "https://raw.githubusercontent.com/chazlarson/PMM_Auth/main/README.md" + start="You can run it in Docker or Python." + %} + diff --git a/mkdocs.yml b/mkdocs.yml index 7828c387..12af256d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -51,6 +51,7 @@ plugins: - glightbox - search: lang: en + - open-in-new-tab - include-markdown - redirects: redirect_maps: