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

readme template polishing

This commit is contained in:
kjeld Schouten-Lebbing 2021-08-19 11:38:55 +02:00
parent d928be0816
commit 1cfb37f6bd
No known key found for this signature in database
GPG Key ID: 4CDAD4A532BC1EDB
2 changed files with 7 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
tools/templates/docs/CONFIG.md.gotmpl
View File

@ -6,8 +6,8 @@
{{ template "custom.custom.configuration.header" . }}
##### Connecting to other apps
If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our "Linking Apps Together" guide:
https://truecharts.org/manual/linking/
If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our "Linking Apps Internally" quick-start guide:
https://truecharts.org/manual/Quick-Start%20Guides/14-linking-apps/
##### Available config options

20
tools/templates/docs/README.md.gotmpl
View File

@ -11,7 +11,7 @@ https://github.com/truecharts/apps
{{- end -}}
{{- define "custom.helm.url" -}}
https://charts.truecharts.org
https://truecharts.org
{{- end -}}
{{- define "custom.helm.path" -}}
@ -38,32 +38,22 @@ TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not gu
{{- define "custom.install" -}}
## Installing the Chart
To install the chart with the release name `{{ template "chart.name" . }}`
To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/03-Installing-an-App/).
- Open TrueNAS SCALE
- Go to Apps
- Click "Install" for this specific Apps
- Fill out the configuration form
{{- end -}}
{{- define "custom.uninstall" -}}
## Uninstalling the Chart
To uninstall the `{{ template "chart.name" . }}` deployment
- Open TrueNAS SCALE
- Go to Apps
- Go to "Installed Apps"
- Expand the menu in the top-right corner of this App
- Click "Remove" for this specific Apps
The command removes all the Kubernetes components associated with the chart **including storage volumes** _(Except hostPath Storage)_ and deletes the release.
To remove this App from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/07-Deleting-an-App/).
{{- end -}}
{{- define "custom.support" -}}
## Support
- Please check our [quick-start guides](https://truecharts.org/manual/Quick-Start%20Guides/01-Open-Apps/) 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)
- Ask a [question](https://github.com/truecharts/apps/discussions)
{{- end -}}