diff --git a/docs/_static/form.css b/docs/_static/form.css index 04352ed7ee1..8719c5ec7a8 100644 --- a/docs/_static/form.css +++ b/docs/_static/form.css @@ -21,6 +21,7 @@ font-size: 16px; font-weight: 600; margin-top: 10px; + text-align: center; } .input-container { diff --git a/docs/manual/Quick-Start Guides/02-Installing-an-App.md b/docs/manual/Quick-Start Guides/02-Installing-an-App.md index 98555748da0..9592a284206 100644 --- a/docs/manual/Quick-Start Guides/02-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/7d9Vjhxu5Po) +![type:video](https://www.youtube.com/embed/9UDUMFiaXBM) diff --git a/docs/manual/Quick-Start Guides/03-Edit-an-App.md b/docs/manual/Quick-Start Guides/03-Edit-an-App.md index af77ffaeb0c..a5d95abe9c8 100644 --- a/docs/manual/Quick-Start Guides/03-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/3ki2AlBYwsc) +![type:video](https://www.youtube.com/embed/UyqM798Arbo) ##### Notes diff --git a/docs/manual/Quick-Start Guides/04-Upgrade-rollback-delete-an-App.md b/docs/manual/Quick-Start Guides/04-Upgrade-rollback-delete-an-App.md index 41cbc6347ad..9438f30e6f2 100644 --- a/docs/manual/Quick-Start Guides/04-Upgrade-rollback-delete-an-App.md +++ b/docs/manual/Quick-Start Guides/04-Upgrade-rollback-delete-an-App.md @@ -66,4 +66,4 @@ Ofcoarse only enter the version number in the GUI or CLI, not the name #### Video Guide -![type:video](https://www.youtube.com/embed/fs9Psx626Gs) +![type:video](https://www.youtube.com/embed/ONbMhQJPQwc) diff --git a/docs/manual/Quick-Start Guides/05-add-storage.md b/docs/manual/Quick-Start Guides/05-add-storage.md index a1872d1f891..c78bb440900 100644 --- a/docs/manual/Quick-Start Guides/05-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/ToPv3Bb-9jw) +![type:video](https://www.youtube.com/embed/aktv1r-KRI0) ##### Additional Documentation diff --git a/docs/manual/Quick-Start Guides/06-linking-apps.md b/docs/manual/Quick-Start Guides/06-linking-apps.md index cb290e72c72..2aa87096aec 100644 --- a/docs/manual/Quick-Start Guides/06-linking-apps.md +++ b/docs/manual/Quick-Start Guides/06-linking-apps.md @@ -11,22 +11,22 @@ Instead we need to use their internal(!) domain name. Please beware: this name i The format for internal domain name for the main service is explained bellow. Please replace `$NAME` with the name you gave your App when installing and `$APP` with the name the app has on the catalog where is needed. -**If your app has the _same_ name as in the catalog, the format is as follows.** +**If your app name __contains__ the name of the app as in the catalog, the format is as follows.** - `$NAME.ix-$NAME.svc.cluster.local` -**If your app has _different_ name than in the catalog, the format is as follows** +**If your app name __does NOT contain__ the name of the app as in the catalog, the format is as follows.** - `$NAME-$APP.ix-$NAME.svc.cluster.local` If you need to reach a different service (which is not often the case!), you need a slightly different format, where `$SVCNAME` is the name of the service you want to reach: -**If your app has the _same_ name as in the catalog, the format is as follows.** +**If your app name __contains__ the name of the app as in the catalog, the format is as follows.** - `$NAME-$SVCNAME.ix-$NAME.svc.cluster.local` -**If your app has _different_ name than in the catalog, the format is as follows** +**If your app name __does NOT contain__ the name of the app as in the catalog, the format is as follows.** - `$NAME-$APPNAME-$SVCNAME.ix-$NAME.svc.cluster.local` @@ -35,16 +35,16 @@ If you need to reach a different service (which is not often the case!), you nee

-
Generate Internal DNS Name:
+
Generate Internal DNS Name
- +
- +
@@ -67,7 +67,7 @@ function submit(event) { var svcname = "" - if (name.value == app.value) { + if (name.value.includes(app.value)) { svcname = name.value ; } else { svcname = name.value + "-" + app.value ; @@ -75,7 +75,8 @@ function submit(event) { if (service.value) { svcname = svcname + "-" + service.value ; } - let svcdns = svcname + "." + "ix-" + name.value + ".svc.cluster.local" ; + let svcdns = svcname + ".ix-" + name.value + ".svc.cluster.local" ; + alert ("Service DNS Name: " + svcdns); console.log(svcdns) return false; @@ -84,16 +85,22 @@ function submit(event) { ##### Example -To reach an app named "sabnzbd" (same name as the catalog app name) within Sonarr, we can use the following internal domain name: +To reach an app named "my-sabnzbd-app" or "sabnzbd' (name contains the catalog app name) within Sonarr, we can use the following internal domain name: - `sabnzbd.ix-sabnzbd.svc.cluster.local` or - `sabnzbd.ix-sabnzbd` +To reach an app named "sab" (name does NOT contain catalog app name) within Sonarr, we can use the following internal domain name: + +- `sab-sabnzbd.ix-sab.svc.cluster.local` or +- `sab-sabnzbd.ix-sab` + + #### Video Guide -![type:video](https://www.youtube.com/embed/6Kg_aEKp7Yg) +![type:video](https://www.youtube.com/embed/mWJL-XDgH98) ##### Additional Documentation diff --git a/docs/manual/Quick-Start Guides/07-adding-letsencrypt.md b/docs/manual/Quick-Start Guides/07-adding-letsencrypt.md index d76974dab7b..dc2ff36acdf 100644 --- a/docs/manual/Quick-Start Guides/07-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/KC7wGqusSxE) +![type:video](https://www.youtube.com/embed/TJ5fDiDRcbU) diff --git a/docs/manual/Quick-Start Guides/08-installing-Traefik.md b/docs/manual/Quick-Start Guides/08-installing-Traefik.md index 573bc74236d..7e62b74cf59 100644 --- a/docs/manual/Quick-Start Guides/08-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/NMpUjbGNLUo) +![type:video](https://www.youtube.com/embed/bWNPfrKjawIo) diff --git a/docs/manual/Quick-Start Guides/09-add-ingress.md b/docs/manual/Quick-Start Guides/09-add-ingress.md index 20e2e770177..6213d305c8d 100644 --- a/docs/manual/Quick-Start Guides/09-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//MlyRvF3rOhE) +![type:video](https://www.youtube.com/embed/0Rmav5gyAwI) ### Notes diff --git a/docs/manual/Quick-Start Guides/10-add-middleware.md b/docs/manual/Quick-Start Guides/10-add-middleware.md index 1e84b31dc17..4eaf839d866 100644 --- a/docs/manual/Quick-Start Guides/10-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/dfWCREdTHnY) +![type:video](https://www.youtube.com/embed/hDdFKE5-c44) diff --git a/docs/manual/Quick-Start Guides/11-external-services.md b/docs/manual/Quick-Start Guides/11-external-services.md index fbd972f0682..717f1f98144 100644 --- a/docs/manual/Quick-Start Guides/11-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/iEBLwCWZuRg) +![type:video](https://www.youtube.com/embed/PFJM0ZhOp6s) ##### Additional Documentation diff --git a/docs/manual/Quick-Start Guides/13-docker-compose.md b/docs/manual/Quick-Start Guides/13-docker-compose.md index 3b72b68a02a..6566def02e6 100644 --- a/docs/manual/Quick-Start Guides/13-docker-compose.md +++ b/docs/manual/Quick-Start Guides/13-docker-compose.md @@ -35,6 +35,6 @@ Our docker-compose solution works almost like using it on the host, but without #### Video Guide -![type:video](https://www.youtube.com/watch?v=QXooywQSfJY) +![type:video](https://www.youtube.com/embed/QXooywQSfJY) ##### Additional Documentation diff --git a/templates/docs/README.md.gotmpl b/templates/docs/README.md.gotmpl index 26c6d4cc651..cd489c1fa99 100644 --- a/templates/docs/README.md.gotmpl +++ b/templates/docs/README.md.gotmpl @@ -30,17 +30,17 @@ TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not gu {{- define "custom.install" -}} ## Installing the Chart -To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/03-Installing-an-App/). +To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/02-Installing-an-App/). {{- end -}} {{- define "custom.uninstall" -}} -## Uninstalling the Chart +## Upgrading, Rolling Back and Uninstalling the Chart -To remove this App from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/07-Deleting-an-App/). +To upgrade, rollback or delete this App from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/04-Upgrade-rollback-delete-an-App/). {{- end -}} {{- define "custom.support" -}} ## Support -- Please check our [quick-start guides](https://truecharts.org/manual/Quick-Start%20Guides/01-Open-Apps/) first. +- Please check our [quick-start guides](https://truecharts.org/manual/Quick-Start%20Guides/01-Adding-TrueCharts/) first. - See the [Wiki](https://truecharts.org) - Check our [Discord](https://discord.gg/tVsPTHWTtr) - Open a [issue](https://github.com/truecharts/apps/issues/new/choose) diff --git a/templates/docs/common-README.md.gotmpl b/templates/docs/common-README.md.gotmpl index 87b88cfb939..eea45941a6f 100644 --- a/templates/docs/common-README.md.gotmpl +++ b/templates/docs/common-README.md.gotmpl @@ -36,7 +36,7 @@ WARNING: THIS CHART IS NOT MEANT TO BE INSTALLED DIRECTLY {{- define "custom.support" -}} ## Support -- Please check our [quick-start guides](https://truecharts.org/manual/Quick-Start%20Guides/01-Open-Apps/) first. +- Please check our [quick-start guides](https://truecharts.org/manual/Quick-Start%20Guides/01-Adding-TrueCharts/) first. - See the [Wiki](https://truecharts.org) - Check our [Discord](https://discord.gg/tVsPTHWTtr) - Open a [issue](https://github.com/truecharts/apps/issues/new/choose)