Cloned2Preserve
/
TrueChartsClone
mirror of https://github.com/truecharts/charts.git
1
0
Fork 0
Code

fix(docs): Update internal dns generator and fix some 404 links (#2212) 

* fix(docs): Update internal dns generator

* update some links

* one more
This commit is contained in:
Stavros Kois 2022-03-18 22:56:45 +02:00 committed by GitHub
parent eb61b2c7a1
commit bad16311ab
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 34 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/_static/form.css vendored
View File

@ -21,6 +21,7 @@
font-size: 16px;
font-weight: 600;
margin-top: 10px;
text-align: center;
}
.input-container {

2
docs/manual/Quick-Start Guides/02-Installing-an-App.md
View File

@ -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)

2
docs/manual/Quick-Start Guides/03-Edit-an-App.md
View File

@ -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

2
docs/manual/Quick-Start Guides/04-Upgrade-rollback-delete-an-App.md
View File

@ -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)

2
docs/manual/Quick-Start Guides/05-add-storage.md
View File

@ -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

29
docs/manual/Quick-Start Guides/06-linking-apps.md
View File

@ -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
<link href="https://truecharts.org/_static/form.css" type="text/css" rel="stylesheet" />
<FORM id="frameform"><BR>
<div class="form">
<div class="subtitle">Generate Internal DNS Name:</div>
<div class="subtitle">Generate Internal DNS Name</div>
<div class="input-container ic1">
<input required id="name" class="input" type="text" placeholder=" " />
<div class="cut cut-short-name"></div>
<label for="name" class="placeholder">Name</label>
<label for="name" class="placeholder">Name (e.g. my-plex-app)</label>
</div>
<div class="input-container ic2">
<input required id="app" class="input" type="text" placeholder=" " />
<div class="cut cut-short-app"></div>
<label for="app" class="placeholder">App</label>
<label for="app" class="placeholder">App (e.g. plex)</label>
</div>
<div class="input-container ic2">
<input id="service" class="input" type="text" placeholder=" " />
@ -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`
<a href="https://truecharts.org/_static/img/linking/linking-example-sonarrsabnzbd.png"><img src="https://truecharts.org/_static/img/linking/linking-example-sonarrsabnzbd.png" width="100%"/></a>
#### Video Guide
![type:video](https://www.youtube.com/embed/6Kg_aEKp7Yg)
![type:video](https://www.youtube.com/embed/mWJL-XDgH98)
##### Additional Documentation

2
docs/manual/Quick-Start Guides/07-adding-letsencrypt.md
View File

@ -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)

2
docs/manual/Quick-Start Guides/08-installing-Traefik.md
View File

@ -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)

2
docs/manual/Quick-Start Guides/09-add-ingress.md
View File

@ -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

2
docs/manual/Quick-Start Guides/10-add-middleware.md
View File

@ -2,4 +2,4 @@
#### Video Guide
![type:video](https://www.youtube.com/embed/dfWCREdTHnY)
![type:video](https://www.youtube.com/embed/hDdFKE5-c44)

2
docs/manual/Quick-Start Guides/11-external-services.md
View File

@ -3,7 +3,7 @@
#### Video Guide
![type:video](https://www.youtube.com/embed/iEBLwCWZuRg)
![type:video](https://www.youtube.com/embed/PFJM0ZhOp6s)
##### Additional Documentation

2
docs/manual/Quick-Start Guides/13-docker-compose.md
View File

@ -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

8
templates/docs/README.md.gotmpl
View File

@ -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)

2
templates/docs/common-README.md.gotmpl
View File

@ -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)