From 1cfb37f6bdba4f43791511c9bfe036eaf5046573 Mon Sep 17 00:00:00 2001 From: kjeld Schouten-Lebbing Date: Thu, 19 Aug 2021 11:38:55 +0200 Subject: [PATCH] readme template polishing --- tools/templates/docs/CONFIG.md.gotmpl | 4 ++-- tools/templates/docs/README.md.gotmpl | 20 +++++--------------- 2 files changed, 7 insertions(+), 17 deletions(-) diff --git a/tools/templates/docs/CONFIG.md.gotmpl b/tools/templates/docs/CONFIG.md.gotmpl index 58c495dc8b5..3d59a05ac38 100644 --- a/tools/templates/docs/CONFIG.md.gotmpl +++ b/tools/templates/docs/CONFIG.md.gotmpl @@ -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 diff --git a/tools/templates/docs/README.md.gotmpl b/tools/templates/docs/README.md.gotmpl index 8c7cf059338..c0dbc69e517 100644 --- a/tools/templates/docs/README.md.gotmpl +++ b/tools/templates/docs/README.md.gotmpl @@ -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 -}}