Kjeld Schouten-Lebbing
1d51be0e3d
Squashed commit: [9ae7dd0f] add helm-docs to workflow [2206f5ba] fix small typo in workflows (+1 squashed commits) Squashed commits: [29c2ceb4] Documentation-Cleanup (#181) * work on readme generation * document windows setup * add simple pre-commit install script * more docs for git setup * Update pre-commit * pre-commit automatic fixes * Increase all patch versions * Auto Readme and Config doc * Auto app-readme.md generation * increase common and common-test versions accordingly (due to cleanup) * move contribution guidelines to /development in wiki * fix some end-of-line issues (again) * fix line 14 of workflows
96 lines
2.5 KiB
Go Template
96 lines
2.5 KiB
Go Template
{{- define "custom.introheader" -}}
|
|
# Introduction
|
|
{{- end -}}
|
|
|
|
{{- 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 are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a stand-alone helm installation.
|
|
**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
|
|
|
|
To install the chart with the release name `{{ template "chart.name" . }}`
|
|
|
|
- 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.
|
|
{{- end -}}
|
|
|
|
{{- define "custom.configuration.header" -}}
|
|
## Configuration
|
|
{{- end -}}
|
|
|
|
{{- define "custom.support" -}}
|
|
## Support
|
|
|
|
- See the [Wiki](https://wiki.truecharts.org)
|
|
- Open a [issue](https://github.com/truecharts/charts/issues/new/choose)
|
|
- Ask a [question](https://github.com/truecharts/charts/discussions)
|
|
{{- end -}}
|
|
|
|
{{ template "custom.introheader" . }}
|
|
|
|
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
|
|
|
{{ template "chart.description" . }}
|
|
|
|
{{ template "custom.notes" . }}
|
|
|
|
{{ template "chart.sourcesSection" . }}
|
|
|
|
{{ template "custom.requirements" . }}
|
|
|
|
{{ template "custom.dependencies" . }}
|
|
|
|
{{ template "custom.install" . }}
|
|
|
|
{{ template "custom.uninstall" . }}
|
|
|
|
{{ template "custom.support" . }}
|
|
|
|
{{ template "helm-docs.versionFooter" . }}
|