-
-
Notifications
You must be signed in to change notification settings - Fork 891
docs(settings): improve Metadata settings docs #3140
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Crow-Control
wants to merge
6
commits into
seerr-team:develop
Choose a base branch
from
Crow-Control:metadata-docs
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+44
−0
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
13427bd
docs(settings): improve Metadata settings docs
Crow-Control cf3d1c9
Apply suggestion from @Crow-Control
Crow-Control 62a9164
Update metadata.md
Crow-Control 727b3a6
Update metadata.md
Crow-Control e14852b
Update metadata.md
Crow-Control 9db8585
Update metadata.md
Crow-Control File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| --- | ||
| title: Metadata Providers | ||
| description: Configure the metadata providers Seerr uses. | ||
| sidebar_position: 8 | ||
| --- | ||
|
|
||
| # Metadata Providers | ||
|
|
||
| Seerr fetches descriptive metadata (titles, descriptions, posters, release dates, | ||
| external IDs, etc.) from a number of third-party providers. The | ||
| **Settings → Metadata Providers** page lets administrators pick which provider | ||
| is used for each media type. | ||
|
|
||
| A **Test** button at the top and bottom of the page exercises every configured | ||
| provider and updates the two status badges (`TheMovieDB`, `TheTVDB`). Each badge shows one of: | ||
|
|
||
| - **Operational** — the test request succeeded. | ||
| - **Not tested** — no test has been run yet in this session. | ||
| - **Failed** — the test request errored; a toast describes which provider(s) | ||
| failed so the issue can be resolved without scrolling back up. | ||
|
|
||
| ## Metadata Provider Selection | ||
|
|
||
| This section controls which provider is used for which media type. | ||
|
|
||
| ### TV series Metadata Provider | ||
|
|
||
| Choose between **TheMovieDB** and **TheTVDB** as the source of metadata for TV | ||
| series. TheMovieDB is the default and matches the source used for movies, which | ||
| keeps IDs and artwork consistent across the UI. | ||
|
|
||
| ### Anime Metadata Provider | ||
|
|
||
| Choose between **TheMovieDB** and **TheTVDB** for anime entries. | ||
|
|
||
| ## Metadata Provider Testing | ||
|
|
||
| The **Test** buttons make one request per provider. | ||
|
|
||
| *TMDB / TVDB are tested only when selected as the active provider for one of | ||
| the media types.* | ||
|
|
||
| If any test fails, an error is shown for that provider and its status badge is | ||
| updated. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mention of movies in a section that talks about TV series is, imo, is quite weird. I feel this would sound more natural in the section above this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be more helpful if you used the edit button yourself for this though.
because this would mean rewriting 10%, then getting new review feedback on the rewrite ending in an endless loop of reviews.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This message wasn't an affirmation but rather a thought that’s why he used phrases like 'imo' and 'I feel.' The goal was to gather feedback from you and the other maintainers.
Also, we avoid editing PRs directly because we let contributors manage their own PRs, as direct edits could be perceived as intrusive except if the author give this approval.