Delete templates/docs directory
Signed-off-by: Kjeld Schouten <kjeld@schouten-lebbing.nl>
This commit is contained in:
Kjeld Schouten
GitHub
parent
104f3f635b
commit
ff1803e7d8
|
|
@ -1,28 +0,0 @@
|
||||||
---
|
|
||||||
title: README
|
|
||||||
---
|
|
||||||
|
|
||||||
## General Info
|
|
||||||
|
|
||||||
TrueCharts can be installed as both _normal_ Helm Charts or as Apps on TrueNAS SCALE.
|
|
||||||
However only installations using the TrueNAS SCALE Apps system are supported.
|
|
||||||
|
|
||||||
For more information about this App, please check the docs on the TrueCharts [website](https://truecharts.org/charts/TRAINPLACEHOLDER/CHARTPLACEHOLDER)
|
|
||||||
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)**
|
|
||||||
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- Please check our [quick-start guides for TrueNAS SCALE](https://truecharts.org/manual/SCALE/guides/scale-intro).
|
|
||||||
- See the [Website](https://truecharts.org)
|
|
||||||
- Check our [Discord](https://discord.gg/tVsPTHWTtr)
|
|
||||||
- Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Sponsor TrueCharts
|
|
||||||
|
|
||||||
TrueCharts can only exist due to the incredible effort of our staff.
|
|
||||||
Please consider making a [donation](https://truecharts.org/sponsor) or contributing back to the project any way you can!
|
|
||||||
|
|
||||||
_All Rights Reserved - The TrueCharts Project_
|
|
||||||
|
|
@ -1,156 +0,0 @@
|
||||||
{{- define "custom.repository.organization" -}}
|
|
||||||
TrueCharts
|
|
||||||
{{- end -}}
|
|
||||||
{{- define "custom.repository.url" -}}
|
|
||||||
https://github.com/truecharts/charts
|
|
||||||
{{- end -}}
|
|
||||||
{{- define "custom.helm.url" -}}
|
|
||||||
https://charts.truecharts.org
|
|
||||||
{{- end -}}
|
|
||||||
{{- define "custom.helm.path" -}}
|
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
|
||||||
{{- end -}}
|
|
||||||
{{- define "custom.notes" -}}
|
|
||||||
TrueCharts can be installed as both _normal_ Helm Charts or as Apps on TrueNAS SCALE.
|
|
||||||
|
|
||||||
This readme is just an automatically generated general guide on installing our Helm Charts and Apps.
|
|
||||||
For more information, please click here: [{{ template "chart.name" . }}](https://truecharts.org/charts/TRAINPLACEHOLDER/{{ template "chart.name" . }})
|
|
||||||
|
|
||||||
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)**
|
|
||||||
{{- end -}}
|
|
||||||
{{- define "custom.requirements" -}}
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
|
||||||
{{- end -}}
|
|
||||||
{{- define "custom.dependencies" -}}
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
|
||||||
{{- end -}}
|
|
||||||
{{- define "custom.install" -}}
|
|
||||||
## Installing the Chart
|
|
||||||
|
|
||||||
### TrueNAS SCALE
|
|
||||||
|
|
||||||
To install this Chart on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/SCALE/guides/scale-intro).
|
|
||||||
|
|
||||||
### Helm
|
|
||||||
|
|
||||||
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
|
|
||||||
helm repo update
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
{{- define "custom.uninstall" -}}
|
|
||||||
## Uninstall
|
|
||||||
|
|
||||||
### TrueNAS SCALE
|
|
||||||
|
|
||||||
**Upgrading, Rolling Back and Uninstalling the Chart**
|
|
||||||
|
|
||||||
To upgrade, rollback or delete this Chart from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/SCALE/guides/scale-intro).
|
|
||||||
|
|
||||||
### Helm
|
|
||||||
|
|
||||||
To uninstall the `{{ template "chart.name" . }}` deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm uninstall {{ template "chart.name" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
{{- define "custom.configuration.header" -}}
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
### Helm
|
|
||||||
|
|
||||||
{{- end -}}
|
|
||||||
{{- define "custom.configuration.readValues" -}}
|
|
||||||
#### Available Settings
|
|
||||||
|
|
||||||
Read through the values.yaml file. It has several commented out suggested values.
|
|
||||||
Other values may be used from the [values.yaml](https://github.com/truecharts/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/truecharts/library-charts/tree/main/charts/common).
|
|
||||||
{{- end -}}
|
|
||||||
{{- define "custom.configuration.example.set" -}}
|
|
||||||
#### Configure using the command line
|
|
||||||
|
|
||||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} \
|
|
||||||
--set env.TZ="America/New York" \
|
|
||||||
{{ template "custom.helm.path" . }}
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
{{- define "custom.configuration.example.file" -}}
|
|
||||||
#### Configure using a yaml file
|
|
||||||
|
|
||||||
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
|
|
||||||
|
|
||||||
```console
|
|
||||||
helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
|
|
||||||
```
|
|
||||||
{{- end -}}
|
|
||||||
{{- define "custom.linking" -}}
|
|
||||||
#### Connecting to other charts
|
|
||||||
|
|
||||||
If you need to connect this Chart to other Charts on TrueNAS SCALE, please refer to our [Linking Apps Internally](https://truecharts.org/manual/SCALE/guides/linking-apps) quick-start guide.
|
|
||||||
{{- end -}}
|
|
||||||
{{- define "custom.support" -}}
|
|
||||||
## Support
|
|
||||||
|
|
||||||
- Please check our [quick-start guides for TrueNAS SCALE](https://truecharts.org/manual/SCALE/guides/scale-intro).
|
|
||||||
- See the [Website](https://truecharts.org)
|
|
||||||
- Check our [Discord](https://discord.gg/tVsPTHWTtr)
|
|
||||||
- Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
|
|
||||||
{{- end -}}
|
|
||||||
{{- define "custom.sponsors" -}}
|
|
||||||
## Sponsor TrueCharts
|
|
||||||
|
|
||||||
TrueCharts can only exist due to the incredible effort of our staff.
|
|
||||||
Please consider making a [donation](https://truecharts.org/sponsor) or contributing back to the project any way you can!
|
|
||||||
{{- end -}}
|
|
||||||
{{- define "custom.copyright" -}}
|
|
||||||
All Rights Reserved - The TrueCharts Project
|
|
||||||
{{- end -}}
|
|
||||||
{{ template "chart.header" . }}
|
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
|
||||||
|
|
||||||
{{ template "chart.deprecationWarning" . }}
|
|
||||||
|
|
||||||
{{ template "custom.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.sourcesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.requirements" . }}
|
|
||||||
|
|
||||||
{{ template "custom.dependencies" . }}
|
|
||||||
|
|
||||||
{{ template "custom.install" . }}
|
|
||||||
|
|
||||||
{{ template "custom.uninstall" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.header" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.readValues" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.set" . }}
|
|
||||||
|
|
||||||
{{ template "custom.configuration.example.file" . }}
|
|
||||||
|
|
||||||
{{ template "custom.linking" . }}
|
|
||||||
|
|
||||||
{{ template "custom.support" . }}
|
|
||||||
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
{{ template "custom.sponsors" . }}
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
{{ template "custom.copyright" . }}
|
|
||||||
|
|
@ -1,22 +0,0 @@
|
||||||
{{- define "custom.helm.introheader" -}}
|
|
||||||
# Default Helm-Values
|
|
||||||
{{- end -}}
|
|
||||||
{{- define "custom.helm.notes" -}}
|
|
||||||
TrueCharts is primarily build to supply TrueNAS SCALE Apps.
|
|
||||||
However, we also supply all Apps as standard Helm-Charts. In this document we aim to document the default values in our values.yaml file.
|
|
||||||
|
|
||||||
Most of our Apps also consume our "common" Helm Chart.
|
|
||||||
If this is the case, this means that all values.yaml values are set to the common chart values.yaml by default. This values.yaml file will only contain values that deviate from the common chart.
|
|
||||||
You will, however, be able to use all values referenced in the common chart here, besides the values listed in this document.
|
|
||||||
{{- end -}}
|
|
||||||
|
|
||||||
{{- define "custom.helm.copyright" -}}
|
|
||||||
All Rights Reserved - The TrueCharts Project
|
|
||||||
{{- end -}}
|
|
||||||
{{ template "custom.helm.introheader" . }}
|
|
||||||
|
|
||||||
{{ template "custom.helm.notes" . }}
|
|
||||||
|
|
||||||
{{ template "chart.valuesSection" . }}
|
|
||||||
|
|
||||||
{{ template "custom.helm.copyright" . }}
|
|
||||||
|
|
@ -1,5 +0,0 @@
|
||||||
---
|
|
||||||
title: APPNAME
|
|
||||||
---
|
|
||||||
|
|
||||||
Currently we're reworking these intropages for each app, please use the menu on the left to select other available documentation pages for each app, including this one.
|
|
||||||
Loading…
Reference in New Issue