Fix some docs bugs
This commit is contained in:
@@ -69,7 +69,7 @@ jobs:
|
|||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
uses: pre-commit/action@v2.0.3
|
uses: pre-commit/action@v2.0.3
|
||||||
|
|
||||||
- name: (re)generate docs
|
- name: update versions in docs
|
||||||
run: |
|
run: |
|
||||||
for train in stable incubator develop non-free deprecated; do
|
for train in stable incubator develop non-free deprecated; do
|
||||||
for chart in charts/${train}/*; do
|
for chart in charts/${train}/*; do
|
||||||
@@ -87,6 +87,11 @@ jobs:
|
|||||||
--output-file="CONFIG.md" \
|
--output-file="CONFIG.md" \
|
||||||
--template-files="/home/runner/work/apps/apps/templates/docs/CONFIG.md.gotmpl" \
|
--template-files="/home/runner/work/apps/apps/templates/docs/CONFIG.md.gotmpl" \
|
||||||
--chart-search-root="${chart}"
|
--chart-search-root="${chart}"
|
||||||
|
helm-docs \
|
||||||
|
--ignore-file=".helmdocsignore" \
|
||||||
|
--output-file="app-readme.md" \
|
||||||
|
--template-files="/home/runner/work/apps/apps/templates/docs/app-readme.md.gotmpl" \
|
||||||
|
--chart-search-root="${chart}"
|
||||||
fi
|
fi
|
||||||
done
|
done
|
||||||
done
|
done
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
{{- define "custom.custom.configuration.header" -}}
|
{{- define "custom.custom.configuration.header" -}}
|
||||||
# Configuration Options
|
# Configuration Options
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
|
|
||||||
{{- define "custom.custom.configuration" -}}
|
{{- define "custom.custom.configuration" -}}
|
||||||
{{ template "custom.custom.configuration.header" . }}
|
{{ template "custom.custom.configuration.header" . }}
|
||||||
|
|
||||||
@@ -13,5 +12,4 @@ https://truecharts.org/manual/Quick-Start%20Guides/14-linking-apps/
|
|||||||
##### Available config options
|
##### Available config options
|
||||||
In the future this page is going to contain an automated list of options available in the installation/edit UI.
|
In the future this page is going to contain an automated list of options available in the installation/edit UI.
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
|
|
||||||
{{ template "custom.custom.configuration" . }}
|
{{ template "custom.custom.configuration" . }}
|
||||||
|
|||||||
@@ -1,53 +1,42 @@
|
|||||||
{{- define "custom.introheader" -}}
|
{{- define "custom.introheader" -}}
|
||||||
# Introduction
|
# Introduction
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
|
|
||||||
{{- define "custom.repository.organization" -}}
|
{{- define "custom.repository.organization" -}}
|
||||||
TrueCharts
|
TrueCharts
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
|
|
||||||
{{- define "custom.repository.url" -}}
|
{{- define "custom.repository.url" -}}
|
||||||
https://github.com/truecharts/apps
|
https://github.com/truecharts/apps
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
|
|
||||||
{{- define "custom.helm.url" -}}
|
{{- define "custom.helm.url" -}}
|
||||||
https://truecharts.org
|
https://truecharts.org
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
|
|
||||||
{{- define "custom.helm.path" -}}
|
{{- define "custom.helm.path" -}}
|
||||||
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
|
|
||||||
{{- define "custom.notes" -}}
|
{{- 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.
|
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/apps/issues/new/choose)**
|
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/apps/issues/new/choose)**
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
|
|
||||||
{{- define "custom.requirements" -}}
|
{{- define "custom.requirements" -}}
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
{{ template "chart.kubeVersionLine" . }}
|
{{ template "chart.kubeVersionLine" . }}
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
|
|
||||||
{{- define "custom.dependencies" -}}
|
{{- define "custom.dependencies" -}}
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
{{ template "chart.requirementsTable" . }}
|
{{ template "chart.requirementsTable" . }}
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
|
|
||||||
{{- define "custom.install" -}}
|
{{- define "custom.install" -}}
|
||||||
## Installing the Chart
|
## 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/03-Installing-an-App/).
|
||||||
|
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
|
|
||||||
{{- define "custom.uninstall" -}}
|
{{- define "custom.uninstall" -}}
|
||||||
## Uninstalling the Chart
|
## 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 remove this App from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/07-Deleting-an-App/).
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
|
|
||||||
{{- define "custom.support" -}}
|
{{- define "custom.support" -}}
|
||||||
## Support
|
## Support
|
||||||
|
|
||||||
@@ -57,11 +46,9 @@ To remove this App from TrueNAS SCALE check our [Quick-Start Guide](https://true
|
|||||||
- Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
|
- Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
|
||||||
- Ask a [question](https://github.com/truecharts/apps/discussions)
|
- Ask a [question](https://github.com/truecharts/apps/discussions)
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
|
|
||||||
{{- define "custom.copyright" -}}
|
{{- define "custom.copyright" -}}
|
||||||
All Rights Reserved - The TrueCharts Project
|
All Rights Reserved - The TrueCharts Project
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
|
|
||||||
{{ template "custom.introheader" . }}
|
{{ template "custom.introheader" . }}
|
||||||
|
|
||||||
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
|
||||||
|
|||||||
@@ -1,10 +1,8 @@
|
|||||||
{{- define "custom.custom.app-readme" -}}
|
{{- define "custom.custom.app-readme" -}}
|
||||||
{{ template "chart.deprecationWarning" . }}
|
{{ template "chart.deprecationWarning" . }}
|
||||||
|
|
||||||
{{ template "chart.description" . }}
|
{{ template "chart.description" . }}
|
||||||
|
|
||||||
This App is supplied by TrueCharts, for more information please visit https://truecharts.org
|
This App is supplied by TrueCharts, for more information please visit https://truecharts.org
|
||||||
|
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
|
|
||||||
|
|
||||||
{{ template "custom.custom.app-readme" . }}
|
{{ template "custom.custom.app-readme" . }}
|
||||||
|
|||||||
Reference in New Issue
Block a user