diff --git a/.cache/plugin/social/0d7cfa09e7b146dcb7570ae5559bff1d.png b/.cache/plugin/social/0d7cfa09e7b146dcb7570ae5559bff1d.png new file mode 100644 index 0000000..739f8fa Binary files /dev/null and b/.cache/plugin/social/0d7cfa09e7b146dcb7570ae5559bff1d.png differ diff --git a/.cache/plugin/social/294bf0d21e865703736d60c1610296bb.png b/.cache/plugin/social/294bf0d21e865703736d60c1610296bb.png new file mode 100644 index 0000000..cb9c475 Binary files /dev/null and b/.cache/plugin/social/294bf0d21e865703736d60c1610296bb.png differ diff --git a/.cache/plugin/social/bd75af8cf44e72211fcb23ebe85edbf8.png b/.cache/plugin/social/bd75af8cf44e72211fcb23ebe85edbf8.png new file mode 100644 index 0000000..ca560ff Binary files /dev/null and b/.cache/plugin/social/bd75af8cf44e72211fcb23ebe85edbf8.png differ diff --git a/.cache/plugin/social/cb418a9278687a334a2dabf5a4f8e686.png b/.cache/plugin/social/cb418a9278687a334a2dabf5a4f8e686.png new file mode 100644 index 0000000..4af10bb Binary files /dev/null and b/.cache/plugin/social/cb418a9278687a334a2dabf5a4f8e686.png differ diff --git a/.cache/plugin/social/d40f13d0160b389ce055c6678285aba4.png b/.cache/plugin/social/d40f13d0160b389ce055c6678285aba4.png new file mode 100644 index 0000000..db1de08 Binary files /dev/null and b/.cache/plugin/social/d40f13d0160b389ce055c6678285aba4.png differ diff --git a/.cache/plugin/social/f4a47726131de9315c89f11e2f9c9544.png b/.cache/plugin/social/f4a47726131de9315c89f11e2f9c9544.png new file mode 100644 index 0000000..4e38f45 Binary files /dev/null and b/.cache/plugin/social/f4a47726131de9315c89f11e2f9c9544.png differ diff --git a/docs/Installation.md b/docs/Installation.md index 30cf949..a5c7dc7 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -120,3 +120,5 @@ Then, restart all services defined in the Compose file: ```bash docker compose up -d ``` + +:material-clock-edit: Last Updated: 5/31/24 diff --git a/docs/Tutorials/index.md b/docs/Tutorials/index.md deleted file mode 100644 index bf7f6cf..0000000 --- a/docs/Tutorials/index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: Tutorials ---- -## This is a placeholder for the tutorials landing page. diff --git a/docs/blog/.authors.yml b/docs/blog/.authors.yml new file mode 100644 index 0000000..2e22d2a --- /dev/null +++ b/docs/blog/.authors.yml @@ -0,0 +1,6 @@ +authors: + ydkmlt84: + name: Justin Awtry + description: Support/Documentation + avatar: https://github.com/ydkmlt84.png + url: https://github.com/ydkmlt84 diff --git a/docs/blog/index.md b/docs/blog/index.md index c58f16c..d82e079 100644 --- a/docs/blog/index.md +++ b/docs/blog/index.md @@ -1,2 +1,2 @@ -# Blog +# Maintainerr Blog diff --git a/docs/Tutorials/Tutorial_S01E01.md b/docs/blog/posts/Tutorial_S01E01.md similarity index 82% rename from docs/Tutorials/Tutorial_S01E01.md rename to docs/blog/posts/Tutorial_S01E01.md index a27580a..85abbdf 100644 --- a/docs/Tutorials/Tutorial_S01E01.md +++ b/docs/blog/posts/Tutorial_S01E01.md @@ -1,10 +1,22 @@ -ο»ΏThe rule system behind Maintainerr is quite complex, and therefore powerful. When you get the hang of it, you will be cleaning up that mess you call a library in no time. +--- +date: 2024-03-01 +title: Getting Started with Rules (S01E01) +categories: + - Tutorials +authors: + - ydkmlt84 +--- +**Ok so you installed Maintainerr and don't know where to start.** + +The rule system behind Maintainerr is quite complex, and therefore powerful. Getting started can be a little daunting at first. That is only because it is new to you. When you get the hang of it, you will be cleaning up that mess you call a library in no time. This will be the first in a series of tutorials that should help you get more familiar with the rules and rule setup. + +

-poster +poster

-Let's take this movie as an example. This isn't a real movie, but for the purposes of this tutorial we are going to pretend. This movie has the following attributes across Plex, OverSeerr, and Radar: +Let's take the above movie as an example. This isn't a real movie, but for the purposes of this tutorial we are going to pretend. This movie has the following attributes across Plex, OverSeerr, and Radar: **Plex** - @@ -24,11 +36,13 @@ Let's take this movie as an example. This isn't a real movie, but for the purpos | ------------ | ------------ | ------- | | 31Oct2023 | True | 114 minutes | +
> :bulb: This information can be looked at for an actual item in your Plex library. You can do it through the Plex UI or you can parse through the XML of an item. 🌐 → Link to see how to get your Plex Media Info and XML data + We want to make a rule that would add this movie to it's collection. :memo: There are many more attributes available in the API responses of Plex, Sonarr/Radarr, and Overseerr. We are only looking at these specific ones for the tutorial. @@ -41,17 +55,17 @@ We want to make a rule that would add this movie to it's collection. We will start from the top of a new rule. -

screenshot-1

+

screenshot-1

- 1: This is the name of the Rule, and will eventually be the name of the Collection that gets created. - 2: Self explanatory but you can put whatever you want here. It will be shown in Plex when you open the collection. -

+

- 3: Drop-down list of your Plex Libraries. Which library is this rule going to be run against? - 4: This will not be shown if you select a `Movies` library in #3. If you selected a `TVShow` library, your options will be shows/seasons/episodes. What type of TVShow media are we going to run the rule against? An entire show, just seasons, or just episodes? Different options will be made available to you or taken away, depending on what you select here. - 5: Sonarr/Radarr action is what is going to happen after the `action after days` set in #6. Options are dependent on the library and media type from above. `Delete` will remove the files and the item from Sonarr/Radarr. `Unmonitor and delete` will unmonitor (not remove) the item from Sonarr/Radarr but delete the files. `Unmonitor and keep` will unmonitor the item from Sonarr/Radarr and **keep** the files. - 6: Think of this as a "delay" setting. How many days after this rule is ran, items have been matched to this rules filter parameters and added to the collection, will we execute the action set in #5? -

screenshot-2

+

screenshot-2

- 7: How many months are we going to keep logs of this collections actions? - 8: Is this Rule active? Will it be one of the rules ran either by a manual run, or through periodic runs? @@ -62,7 +76,7 @@ We will start from the top of a new rule. - 12: You can toggle the rule system off and on. This is useful if you have collections in Plex that you want to see in Maintainerr, but don't want any actions taken on the collection. - 13: You can create a collection in Plex, and then use that collection in Maintainerr. If you are doing that, tick this Custom Collection box to on. This can be useful if there is a collection made by say PMM or by you, and you want to execute some rules against it. - > screenshot-discord + > screenshot-discord --- @@ -72,7 +86,7 @@ Now we are getting into the nitty gritty. After the settings above have been con > :memo: Community rules are just that, from the community. They may not work like they say they do. They may not be formatted properly. It can be a nice place to start, but I personally wouldn't rely on them as everyone's situation is different. Below the *Community* button there are two other buttons. Import and Export. You can import a rule from a txt file in YAML format (this is an advanced method but it is an option). - > :bulb: If you want to go down this path, I would choose one of the Community rules, doesn't really matter which one, and then use the export button. You will get a generated YAML format of the rule. If you are familiar with YAML this will be a good place to start. Take a look at this page for the proper syntax of each parameter → [Rules Glossary][glossary]. + > :bulb: If you want to go down this path, I would choose one of the Community rules, doesn't really matter which one, and then use the export button. You will get a generated YAML format of the rule. If you are familiar with YAML this will be a good place to start. Take a look at this page for the proper syntax of each parameter → [Rules Glossary](../../Glossary.md). If you are looking at a rule that you have already created, you can export the rule in YAML format, in order to share it or textually edit it. @@ -121,7 +135,5 @@ Now let's try a mixed **AND** / **OR** example... --- -This is a very good jumping off point for you to start making rules. If you are still not 100% confident yet, or just want/need more, take a look at [S01E02][episode2] and go even deeper down the rabbit-hole. +This is a very good jumping off point for you to start making rules. If you are still not 100% confident yet, or just want/need more, take a look at [S01E02](Tutorial_S01E02.md) and go even deeper down the rabbit-hole. -[episode2]: ./Tutorial_S01E02.md -[glossary]: ../Glossary.md diff --git a/docs/Tutorials/Tutorial_S01E02.md b/docs/blog/posts/Tutorial_S01E02.md similarity index 86% rename from docs/Tutorials/Tutorial_S01E02.md rename to docs/blog/posts/Tutorial_S01E02.md index 35fe497..ada7f8b 100644 --- a/docs/Tutorials/Tutorial_S01E02.md +++ b/docs/blog/posts/Tutorial_S01E02.md @@ -1,12 +1,24 @@ -In episode 1 we went over the basic outline of rules and sections as well as operators. In today's episode we will drill down even further. +--- +date: 2024-03-25 +title: Basic Rule Understanding (S01E02) +categories: + - Tutorials +authors: + - ydkmlt84 +--- +**Let's go a little further into Rules with some simple examples to get you started.** +In episode 1 we went over a super basic outline of rules and sections, operators, and general rule setup. In today's episode we will go over some simple rules examples. You could setup a few AND rules and roll with it, but then you wouldn't be using Maintainerr to its full potential. This episode should give you a good base of rule knowledge to build off of. + + Let's bring back the Movie from episode 1, that we wanted to add into our new collection.

-poster +poster

+ This movie has the following attributes across Plex, OverSeerr, and Radar: **Plex** - diff --git a/docs/Tutorials/Tutorial_S01E03.md b/docs/blog/posts/Tutorial_S01E03.md similarity index 93% rename from docs/Tutorials/Tutorial_S01E03.md rename to docs/blog/posts/Tutorial_S01E03.md index a5c3417..d81fce3 100644 --- a/docs/Tutorials/Tutorial_S01E03.md +++ b/docs/blog/posts/Tutorial_S01E03.md @@ -1,17 +1,24 @@ +--- +date: 2024-05-10 +title: All About Sections (S01E03) +categories: + - Tutorials +authors: + - ydkmlt84 +--- +

🎊 **Welcome to Episode 3! It has been a while since our last episode.** 🎊

-classroom +classroom

-# Sections - Today is all about rule sections! **Why do we even have sections?** It has been said that another word to use for sections could be `group`. The reason behind a section is to group a ***section*** of rules together. - -We need a way to group a few rules together that we don't want to be a part of the main rule set. + +We need a way to group a few rules together, that we don't want to be a part of the main rule set. ## Example 1 diff --git a/docs/overrides/homepage/home.html b/docs/overrides/homepage/home.html index b3cac0d..4f26f35 100644 --- a/docs/overrides/homepage/home.html +++ b/docs/overrides/homepage/home.html @@ -49,6 +49,7 @@ .tx-hero__content { padding-bottom: 1rem; margin: 0 auto; + max-width: 26rem !important; } .md-container { background-image: linear-gradient(rgba(0, 0, 0, 0.5), rgba(0, 0, 0, 0.5)), url(images/banner3.png); @@ -233,6 +234,21 @@

The Perfect Media Janitor + Get Started + + Introduction + + + View The Guides + + + + +
+

Docker Run - Quick Start

+
Get Started diff --git a/mkdocs.yml b/mkdocs.yml index 400effc..7681526 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -79,7 +79,12 @@ theme: # Plugins plugins: - - blog + - blog: + blog_toc: true + post_url_format: "/{categories}/{slug}" + categories_slugify: !!python/object/apply:pymdownx.slugs.slugify + kwds: + case: lower #- meta - search: separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])' @@ -177,11 +182,7 @@ nav: - Introduction.md - Contributing.md - Guides: - - Tutorials: - - Tutorials/index.md - - S01E01: Tutorials/Tutorial_S01E01.md - - S01E02: Tutorials/Tutorial_S01E02.md - - S01E03: Tutorials/Tutorial_S01E03.md + - blog/index.md # Custom Homepage Elements home_cover_image: # This path starts at your root mkdocs directory.