From d366d483eb422fe83c7b6ac7c7e2e5b50e9b3b31 Mon Sep 17 00:00:00 2001 From: TRaSH Date: Sun, 24 Apr 2022 20:12:23 +0200 Subject: [PATCH 1/2] Starr index page update - Added: all Star branch versions including warnings - Added: How to update to a Starr Apps branche. --- docs/Radarr/index.md | 51 ++++++++++++++++++++++++++++++++++++-------- docs/Sonarr/index.md | 29 +++++++++++++++++-------- 2 files changed, 62 insertions(+), 18 deletions(-) diff --git a/docs/Radarr/index.md b/docs/Radarr/index.md index 16b389d80..a3d83c12f 100644 --- a/docs/Radarr/index.md +++ b/docs/Radarr/index.md @@ -2,15 +2,48 @@ Here you will find a collection of Radarr Guides I made. -## v3 Radarr Branch: latest +## Master -![version](https://img.shields.io/badge/dynamic/json?query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Fhotio%2Fradarr%2Frelease%2FVERSION.json&label=Latest%20Version&style=for-the-badge&color=4051B5) +![master](https://img.shields.io/badge/dynamic/json?query=%24.version&url=https://raw.githubusercontent.com/hotio/radarr/release/VERSION.json&label=Current%20Master/Stable%20Version&style=for-the-badge&color=4051B5) -- (stable) (v3) -- Builds Pushed only when intentionally released -- Github Branch: master -- Docker: [hotio/radarr:release](https://hub.docker.com/r/hotio/radarr){:target="_blank" rel="noopener noreferrer"} +(Default/Stable): It has been tested by users on the develop and nightly branches and it’s not known to have any major issues. -```bash -hotio/radarr:release -``` +This version will receive updates approximately monthly. + +On GitHub, this is the `master` branch. + +## Develop + +![develop](https://img.shields.io/badge/dynamic/json?query=%24.version&url=https://raw.githubusercontent.com/hotio/radarr/testing/VERSION.json&label=Current%20Develop/Beta%20Version&style=for-the-badge&color=4051B5) + +(Beta): This is the testing edge. Released after tested in nightly to ensure no immediate issues. New features and bug fixes released here first after nightly. It can be considered semi-stable, but is still `beta`. + +This version will receive updates either weekly or biweekly depending on development. + +!!! warning + + **Warning: You may not be able to go back to `master` after switching to this branch.** + +On GitHub, this is a snapshot of the `develop` branch at a specific point in time. + +## Nightly + +![nightly](https://img.shields.io/badge/dynamic/json?query=%24.version&url=https://raw.githubusercontent.com/hotio/radarr/nightly/VERSION.json&label=Current%20Nightly/Unstable%20Version&style=for-the-badge&color=4051B5) + +(Alpha/Unstable) : This is the bleeding edge. It is released as soon as code is committed and passes all automated tests. This build may have not been used by us or other users yet. There is no guarantee that it will even run in some cases. This branch is only recommended for advanced users. Issues and self investigation are expected in this branch. + +!!! danger + + ***Use this branch only if you know what you are doing and are willing to get your hands dirty to recover a failed update.*** + +This version is updated immediately. + +!!! warning + + **Warning: You may not be able to go back to `master` after switching to this branch.** + +On GitHub, this is the `develop` branch. + +### How do I update Radarr? + +External link to the official [WikiArr](https://wiki.servarr.com/en/radarr/faq#how-do-i-update-radarr){:target="_blank" rel="noopener noreferrer"}. diff --git a/docs/Sonarr/index.md b/docs/Sonarr/index.md index c8b6bdf28..c310ca1dd 100644 --- a/docs/Sonarr/index.md +++ b/docs/Sonarr/index.md @@ -2,15 +2,26 @@ Here you will find a collection of Sonarr guides I made. -## v3 Sonarr Branch: latest +## Master -![version](https://img.shields.io/badge/dynamic/json?query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Fhotio%2Fsonarr%2Frelease%2FVERSION.json&label=Latest%20Version&style=for-the-badge&color=4051B5) +![Main](https://img.shields.io/badge/dynamic/json?query=%24.version&url=https://raw.githubusercontent.com/hotio/sonarr/release/VERSION.json&label=Current%20Master/Stable%20Version&style=for-the-badge&color=4051B5) -- (Stable) (v3) -- Builds Pushed only when intentionally released -- Github Branch: main -- Docker: [hotio/sonarr:release](https://hub.docker.com/r/hotio/sonarr){:target="_blank" rel="noopener noreferrer"} +(Default/Stable): This has been tested by users on nightly (`develop`) branch and it's not known to have any major issues. This branch should be used by the majority of users. -```bash -hotio/sonarr:release -``` +On GitHub, this is the `main` branch. + +## Develop + +![Develop](https://img.shields.io/badge/dynamic/json?query=%24.version&url=https://raw.githubusercontent.com/hotio/sonarr/nightly/VERSION.json&label=Current%20Develop/Nightly%20Version&style=for-the-badge&color=4051B5) + +(Alpha/Unstable) : This is the bleeding edge. It is released as soon as code is committed and passes all automated tests. This build may have not been used by us or other users yet. There is no guarantee that it will even run in some cases. This branch is only recommended for advanced users. Issues and self investigation are expected in this branch. + +!!! Warning + + **Warning: You may not be able to go back to `main` after switching to this branch.** + +On GitHub, this is the `develop` branch. + +### How do I update Sonarr? + +External link to the official [WikiArr](https://wiki.servarr.com/en/sonarr/faq#how-do-i-update-sonarr){:target="_blank" rel="noopener noreferrer"}. From 6593599614bc8b19095207d6673ed38975ac3901 Mon Sep 17 00:00:00 2001 From: TRaSH Date: Sun, 24 Apr 2022 20:18:19 +0200 Subject: [PATCH 2/2] Fix: MD026 Trailing punctuation in header - Fix: MD026 Trailing punctuation in header --- docs/Radarr/index.md | 6 +++--- docs/Sonarr/index.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/Radarr/index.md b/docs/Radarr/index.md index a3d83c12f..ab0f2151d 100644 --- a/docs/Radarr/index.md +++ b/docs/Radarr/index.md @@ -22,7 +22,7 @@ This version will receive updates either weekly or biweekly depending on develop !!! warning - **Warning: You may not be able to go back to `master` after switching to this branch.** + **You may not be able to go back to `master` after switching to this branch.** On GitHub, this is a snapshot of the `develop` branch at a specific point in time. @@ -40,10 +40,10 @@ This version is updated immediately. !!! warning - **Warning: You may not be able to go back to `master` after switching to this branch.** + **You may not be able to go back to `master` after switching to this branch.** On GitHub, this is the `develop` branch. -### How do I update Radarr? +### How do I update Radarr External link to the official [WikiArr](https://wiki.servarr.com/en/radarr/faq#how-do-i-update-radarr){:target="_blank" rel="noopener noreferrer"}. diff --git a/docs/Sonarr/index.md b/docs/Sonarr/index.md index c310ca1dd..e81e001a3 100644 --- a/docs/Sonarr/index.md +++ b/docs/Sonarr/index.md @@ -18,10 +18,10 @@ On GitHub, this is the `main` branch. !!! Warning - **Warning: You may not be able to go back to `main` after switching to this branch.** + **You may not be able to go back to `main` after switching to this branch.** On GitHub, this is the `develop` branch. -### How do I update Sonarr? +### How do I update Sonarr External link to the official [WikiArr](https://wiki.servarr.com/en/sonarr/faq#how-do-i-update-sonarr){:target="_blank" rel="noopener noreferrer"}.