Skip to content

[Docs] Add "Managing Recommendations" Guide #2463

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

Merged
merged 2 commits into from
Jan 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions docs/kometa/guides/hub.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Managing Recommendations

The Recommendations Hub allows you granular control over which collections appear on your home screen, the home screen of other users, and the Recommended tab of any given library.

You can use this to disable Plex's default recommendations (such as "Recently Added in Movies") and replace them with any of your favorite Kometa Collections.


## Getting Started

The Recommendations tab is accessed by going to `Settings > Server > Manage > Libraries` within Plex. You can then press the "Manage Recommendations" button against any of your libraries to view the current configuration.

![hub1.gif](images/hub1.gif)

For the purpose of this guide we will disable **all** enabled recommendations.

![hub2.png](images/hub2.png)

In order for a Kometa collection to appear as a Row in the Manage Recommendations section, it must have one of the `visible_home`/`visible_shared`/`visible_library` attributes set to `true`, this can be done in your Collection definition or via a template variable for Defaults files. You can also set these visibility options within the Plex UI, you can read [Plex's guidance](https://support.plex.tv/articles/manage-recommendations/) on how to do this.

Here is an example Collection definition setting all three `visible_*` attributes:

```yaml
collections:
Test:
plex_all: true
visible_home: true
visible_shared: true
visible_library: true
```

And an example Defaults file setting the same attributes:
```yaml
libraries:
Movie Recommendations:
collection_files:
- default: imdb
template_variables:
visible_home: true
visible_shared: true
visible_library: true
```

The results are:

![hub3.png](images/hub3.png)

And if I visit my Plex homepage:

![hub4.png](images/hub4.png)

Collections will be added in the order that Kometa processes them, but you can reorganize them by drag-and-dropping each Row using the tree-line icon.

![hub5.gif](images/hub5.gif)

Binary file added docs/kometa/guides/images/hub1.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/kometa/guides/images/hub2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/kometa/guides/images/hub3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/kometa/guides/images/hub4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/kometa/guides/images/hub5.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,8 @@ nav:
- Image Asset Directory Guide: kometa/guides/assets.md
- Formula 1 Metadata Guide: kometa/guides/formula.md
- MediUX Assets Guide: kometa/guides/mediux.md
- Managing Recommendations: kometa/guides/hub.md

- Reverting Kometa Changes: kometa/guides/revert.md
- Switching from PMM to Kometa: kometa/guides/rebrand.md
- Companion Scripts: &scripts
Expand Down
Loading