From 5a19b8824b45f059e8734ff7e8a12513ec3b094e Mon Sep 17 00:00:00 2001 From: kjeld Schouten-Lebbing Date: Sun, 21 Nov 2021 02:01:40 +0100 Subject: [PATCH] chore(docs): restructure quick-start guides and replace youtube urls --- ...ling-an-App.md => 02-Installing-an-App.md} | 2 +- .../{04-Edit-an-App.md => 03-Edit-an-App.md} | 2 +- ...d => 04-Upgrade-rollback-delete-an-App.md} | 39 ++++++++++++++++++- .../Quick-Start Guides/05-Upgrade-an-App.md | 29 -------------- .../{15-add-storage.md => 05-add-storage.md} | 2 +- ...{14-linking-apps.md => 06-linking-apps.md} | 2 +- .../Quick-Start Guides/07-Deleting-an-App.md | 5 --- ...etsencrypt.md => 07-adding-letsencrypt.md} | 2 +- .../08-Dealing-with-Errors.md | 5 --- ...ng-Traefik.md => 08-installing-Traefik.md} | 2 +- .../{12-add-ingress.md => 09-add-ingress.md} | 2 +- ...add-middleware.md => 10-add-middleware.md} | 2 +- ...al-services.md => 11-external-services.md} | 2 +- .../11-traefik-on-port80.md | 5 --- .../{18-vpn-setup.md => 12-vpn-setup.md} | 2 +- ...e.md => 13-migrate from docker-compose.md} | 0 ...backup-restore.md => 14-backup-restore.md} | 0 17 files changed, 47 insertions(+), 56 deletions(-) rename docs/manual/Quick-Start Guides/{03-Installing-an-App.md => 02-Installing-an-App.md} (95%) rename docs/manual/Quick-Start Guides/{04-Edit-an-App.md => 03-Edit-an-App.md} (96%) rename docs/manual/Quick-Start Guides/{06-Rollback-an-App.md => 04-Upgrade-rollback-delete-an-App.md} (52%) delete mode 100644 docs/manual/Quick-Start Guides/05-Upgrade-an-App.md rename docs/manual/Quick-Start Guides/{15-add-storage.md => 05-add-storage.md} (94%) rename docs/manual/Quick-Start Guides/{14-linking-apps.md => 06-linking-apps.md} (98%) delete mode 100644 docs/manual/Quick-Start Guides/07-Deleting-an-App.md rename docs/manual/Quick-Start Guides/{09-adding-letsencrypt.md => 07-adding-letsencrypt.md} (98%) delete mode 100644 docs/manual/Quick-Start Guides/08-Dealing-with-Errors.md rename docs/manual/Quick-Start Guides/{10-installing-Traefik.md => 08-installing-Traefik.md} (81%) rename docs/manual/Quick-Start Guides/{12-add-ingress.md => 09-add-ingress.md} (96%) rename docs/manual/Quick-Start Guides/{13-add-middleware.md => 10-add-middleware.md} (50%) rename docs/manual/Quick-Start Guides/{16-external-services.md => 11-external-services.md} (60%) delete mode 100644 docs/manual/Quick-Start Guides/11-traefik-on-port80.md rename docs/manual/Quick-Start Guides/{18-vpn-setup.md => 12-vpn-setup.md} (56%) rename docs/manual/Quick-Start Guides/{17-migrate from docker-compose.md => 13-migrate from docker-compose.md} (100%) rename docs/manual/Quick-Start Guides/{19-backup-restore.md => 14-backup-restore.md} (100%) diff --git a/docs/manual/Quick-Start Guides/03-Installing-an-App.md b/docs/manual/Quick-Start Guides/02-Installing-an-App.md similarity index 95% rename from docs/manual/Quick-Start Guides/03-Installing-an-App.md rename to docs/manual/Quick-Start Guides/02-Installing-an-App.md index b55da1a32f3..de4ec1fb494 100644 --- a/docs/manual/Quick-Start Guides/03-Installing-an-App.md +++ b/docs/manual/Quick-Start Guides/02-Installing-an-App.md @@ -23,4 +23,4 @@ Here we will go over a basic install of Plex, to showcase how you can install a #### Video Guide -![type:video](https://www.youtube.com/embed/yJ5fC8UGlz8) +![type:video](https://www.youtube.com/embed/7d9Vjhxu5Po) diff --git a/docs/manual/Quick-Start Guides/04-Edit-an-App.md b/docs/manual/Quick-Start Guides/03-Edit-an-App.md similarity index 96% rename from docs/manual/Quick-Start Guides/04-Edit-an-App.md rename to docs/manual/Quick-Start Guides/03-Edit-an-App.md index 3a721498c26..53194836d2b 100644 --- a/docs/manual/Quick-Start Guides/04-Edit-an-App.md +++ b/docs/manual/Quick-Start Guides/03-Edit-an-App.md @@ -23,7 +23,7 @@ The process popup disapears, it might take a few minutes to actually deploy your #### Video Guide -![type:video](https://www.youtube.com/embed/PseYHVlGYxE) +![type:video](https://www.youtube.com/embed/3ki2AlBYwsc) ##### Notes diff --git a/docs/manual/Quick-Start Guides/06-Rollback-an-App.md b/docs/manual/Quick-Start Guides/04-Upgrade-rollback-delete-an-App.md similarity index 52% rename from docs/manual/Quick-Start Guides/06-Rollback-an-App.md rename to docs/manual/Quick-Start Guides/04-Upgrade-rollback-delete-an-App.md index 8914bcb093e..5cc2ed12ba4 100644 --- a/docs/manual/Quick-Start Guides/06-Rollback-an-App.md +++ b/docs/manual/Quick-Start Guides/04-Upgrade-rollback-delete-an-App.md @@ -1,8 +1,36 @@ -# 06 - App Roleback after an update +# 05 - Upgrading, Rollback and Delete +With TrueCharts we always push new versions of an App for any change. Even for the containers. +This ensures upgrading the App always gives you the Latest-and-Greatest from TrueCharts + +##### Requirements + +- Make sure your storage-pool is created and working +- Make Make sure you selected your storage-pool when you first opened the "Apps" interface, if not please refer to quick-start guide `01 - First time Apps setup` +- Make sure you have a working internet connection and can reach github and truecharts.org from the host system. +- Make sure you already added the TrueCharts catalog from guide 02 +- Make sure your App is installed and, preferably, working + +## Upgrading + +##### Upgrading the App using the GUI + +- Go to `Installed Applications` +- Make sure your App reports that an Upgrade is available on the App Card. +- Make note of the current version, you might want to revert to this version in the future. +- click the menu button on the right side of the App card +- Select `Upgrade` +- Confirm your wish to upgrade + +The App will then go through a process of backuping(!) and upgrading your App your changes. If the proces fails, your changes will not be submitted and the edit will be reverted. +After the process popup disapears, it might take a few minutes to actually deploy your newly upgraded App, due to some things that happen in the background. + + +## Rollback ### Reverting using the GUI + ### Reverting using the CLI 1. enter cli to enter the SCALE command line interface @@ -28,7 +56,14 @@ You'll see this: Take note of the "Chart" column, it lists the version numbers you can enter in the rollback interface, prefixed by the App Name. Ofcoarse only enter the version number in the GUI or CLI, not the name +## Delete + +### Delete using the GUI + + +### Delete using the CLI + #### Video Guide -![type:video](https://www.youtube.com/embed/FtfF3rs_YEk) +![type:video](https://www.youtube.com/embed/fs9Psx626Gs) diff --git a/docs/manual/Quick-Start Guides/05-Upgrade-an-App.md b/docs/manual/Quick-Start Guides/05-Upgrade-an-App.md deleted file mode 100644 index deae841f0ef..00000000000 --- a/docs/manual/Quick-Start Guides/05-Upgrade-an-App.md +++ /dev/null @@ -1,29 +0,0 @@ -# 05 - Upgrading Apps - -With TrueCharts we always push new versions of an App for any change. Even for the containers. -This ensures upgrading the App always gives you the Latest-and-Greatest from TrueCharts - -##### Requirements - -- Make sure your storage-pool is created and working -- Make Make sure you selected your storage-pool when you first opened the "Apps" interface, if not please refer to quick-start guide `01 - First time Apps setup` -- Make sure you have a working internet connection and can reach github and truecharts.org from the host system. -- Make sure you already added the TrueCharts catalog from guide 02 -- Make sure your App is installed and, preferably, working - -##### Upgrading the App - -- Go to `Installed Applications` -- Make sure your App reports that an Upgrade is available on the App Card. -- Make note of the current version, you might want to revert to this version in the future. -- click the menu button on the right side of the App card -- Select `Upgrade` -- Confirm your wish to upgrade - -The App will then go through a process of backuping(!) and upgrading your App your changes. If the proces fails, your changes will not be submitted and the edit will be reverted. -After the process popup disapears, it might take a few minutes to actually deploy your newly upgraded App, due to some things that happen in the background. - - -#### Video Guide - -![type:video](https://www.youtube.com/embed/NsZAGtodJVk) diff --git a/docs/manual/Quick-Start Guides/15-add-storage.md b/docs/manual/Quick-Start Guides/05-add-storage.md similarity index 94% rename from docs/manual/Quick-Start Guides/15-add-storage.md rename to docs/manual/Quick-Start Guides/05-add-storage.md index 460257946be..941ee4d24dd 100644 --- a/docs/manual/Quick-Start Guides/15-add-storage.md +++ b/docs/manual/Quick-Start Guides/05-add-storage.md @@ -17,7 +17,7 @@ Please be aware that automatically setting ownership/permissions, does mean it o #### Video Guide -![type:video](https://www.youtube.com/embed/E0kGqij1tKA) +![type:video](https://www.youtube.com/embed/ToPv3Bb-9jw) ##### Additional Documentation diff --git a/docs/manual/Quick-Start Guides/14-linking-apps.md b/docs/manual/Quick-Start Guides/06-linking-apps.md similarity index 98% rename from docs/manual/Quick-Start Guides/14-linking-apps.md rename to docs/manual/Quick-Start Guides/06-linking-apps.md index 13b7ca29aa2..c86232ab1f9 100644 --- a/docs/manual/Quick-Start Guides/14-linking-apps.md +++ b/docs/manual/Quick-Start Guides/06-linking-apps.md @@ -93,7 +93,7 @@ To reach an app named "sabnzbd" (same name as the catalog app name) within Sonar #### Video Guide -![type:video](https://www.youtube.com/embed/kLzFGCOOGXQ) +![type:video](https://www.youtube.com/embed/6Kg_aEKp7Yg) ##### Additional Documentation diff --git a/docs/manual/Quick-Start Guides/07-Deleting-an-App.md b/docs/manual/Quick-Start Guides/07-Deleting-an-App.md deleted file mode 100644 index 4622891d5b7..00000000000 --- a/docs/manual/Quick-Start Guides/07-Deleting-an-App.md +++ /dev/null @@ -1,5 +0,0 @@ -# 07 - Deleting an App - -#### Video Guide - -![type:video](https://www.youtube.com/embed/GpC6x7Xw7-w) diff --git a/docs/manual/Quick-Start Guides/09-adding-letsencrypt.md b/docs/manual/Quick-Start Guides/07-adding-letsencrypt.md similarity index 98% rename from docs/manual/Quick-Start Guides/09-adding-letsencrypt.md rename to docs/manual/Quick-Start Guides/07-adding-letsencrypt.md index b8742f10e5a..1395d36b8ac 100644 --- a/docs/manual/Quick-Start Guides/09-adding-letsencrypt.md +++ b/docs/manual/Quick-Start Guides/07-adding-letsencrypt.md @@ -53,4 +53,4 @@ For clearity, it's advicable to use the same Authenticator for all domain names. #### Video Guide -![type:video](https://www.youtube.com/embed/nAVFL2LYC7U) +![type:video](https://www.youtube.com/embed/KC7wGqusSxE) diff --git a/docs/manual/Quick-Start Guides/08-Dealing-with-Errors.md b/docs/manual/Quick-Start Guides/08-Dealing-with-Errors.md deleted file mode 100644 index 1458f258390..00000000000 --- a/docs/manual/Quick-Start Guides/08-Dealing-with-Errors.md +++ /dev/null @@ -1,5 +0,0 @@ -# 08 - Dealing with common Errors - -#### Video Guide - -![type:video](https://www.youtube.com/embed/fc6aDVqX0Zo) diff --git a/docs/manual/Quick-Start Guides/10-installing-Traefik.md b/docs/manual/Quick-Start Guides/08-installing-Traefik.md similarity index 81% rename from docs/manual/Quick-Start Guides/10-installing-Traefik.md rename to docs/manual/Quick-Start Guides/08-installing-Traefik.md index 94e1a83dd21..1498a93234f 100644 --- a/docs/manual/Quick-Start Guides/10-installing-Traefik.md +++ b/docs/manual/Quick-Start Guides/08-installing-Traefik.md @@ -4,4 +4,4 @@ Within TrueCharts our aim is to make it as easy as possible to secure your Apps. #### Video Guide -![type:video](https://www.youtube.com/embed/-H2Maoi9Osg) +![type:video](https://www.youtube.com/embed/NMpUjbGNLUo) diff --git a/docs/manual/Quick-Start Guides/12-add-ingress.md b/docs/manual/Quick-Start Guides/09-add-ingress.md similarity index 96% rename from docs/manual/Quick-Start Guides/12-add-ingress.md rename to docs/manual/Quick-Start Guides/09-add-ingress.md index 99a06527ce0..42912297dcb 100644 --- a/docs/manual/Quick-Start Guides/12-add-ingress.md +++ b/docs/manual/Quick-Start Guides/09-add-ingress.md @@ -17,7 +17,7 @@ We currently require Traefik to be installed before you enable ingress on your A #### Video Guide -![type:video](https://www.youtube.com/embed/htIhl3KxWMw) +![type:video](https://www.youtube.com/embed//MlyRvF3rOhE) ### Notes diff --git a/docs/manual/Quick-Start Guides/13-add-middleware.md b/docs/manual/Quick-Start Guides/10-add-middleware.md similarity index 50% rename from docs/manual/Quick-Start Guides/13-add-middleware.md rename to docs/manual/Quick-Start Guides/10-add-middleware.md index 0797f767b87..15a148ba4fa 100644 --- a/docs/manual/Quick-Start Guides/13-add-middleware.md +++ b/docs/manual/Quick-Start Guides/10-add-middleware.md @@ -2,4 +2,4 @@ #### Video Guide -![type:video](https://www.youtube.com/embed/TKh7NXjk91w) +![type:video](https://www.youtube.com/embed/dfWCREdTHnY) diff --git a/docs/manual/Quick-Start Guides/16-external-services.md b/docs/manual/Quick-Start Guides/11-external-services.md similarity index 60% rename from docs/manual/Quick-Start Guides/16-external-services.md rename to docs/manual/Quick-Start Guides/11-external-services.md index f5db3ac6b49..d76ca5a2e68 100644 --- a/docs/manual/Quick-Start Guides/16-external-services.md +++ b/docs/manual/Quick-Start Guides/11-external-services.md @@ -3,7 +3,7 @@ #### Video Guide -![type:video](https://www.youtube.com/embed/DO0CjFdBC9Q) +![type:video](https://www.youtube.com/embed/iEBLwCWZuRg) ##### Additional Documentation diff --git a/docs/manual/Quick-Start Guides/11-traefik-on-port80.md b/docs/manual/Quick-Start Guides/11-traefik-on-port80.md deleted file mode 100644 index 6cfb9a638c5..00000000000 --- a/docs/manual/Quick-Start Guides/11-traefik-on-port80.md +++ /dev/null @@ -1,5 +0,0 @@ -# 11 - Exposing Traefik on port 80/443 - -#### Video Guide - -![type:video](https://www.youtube.com/embed/UHuyn9qCY6g) diff --git a/docs/manual/Quick-Start Guides/18-vpn-setup.md b/docs/manual/Quick-Start Guides/12-vpn-setup.md similarity index 56% rename from docs/manual/Quick-Start Guides/18-vpn-setup.md rename to docs/manual/Quick-Start Guides/12-vpn-setup.md index 0c35af25c5e..0c8636b23a7 100644 --- a/docs/manual/Quick-Start Guides/18-vpn-setup.md +++ b/docs/manual/Quick-Start Guides/12-vpn-setup.md @@ -3,6 +3,6 @@ #### Video Guide -![type:video](https://www.youtube.com/embed/Fwcx7pGUgsM) +![type:video](https://www.youtube.com/embed/zSNApt-Ojng) ##### Additional Documentation diff --git a/docs/manual/Quick-Start Guides/17-migrate from docker-compose.md b/docs/manual/Quick-Start Guides/13-migrate from docker-compose.md similarity index 100% rename from docs/manual/Quick-Start Guides/17-migrate from docker-compose.md rename to docs/manual/Quick-Start Guides/13-migrate from docker-compose.md diff --git a/docs/manual/Quick-Start Guides/19-backup-restore.md b/docs/manual/Quick-Start Guides/14-backup-restore.md similarity index 100% rename from docs/manual/Quick-Start Guides/19-backup-restore.md rename to docs/manual/Quick-Start Guides/14-backup-restore.md