diff --git a/.github/workflows/housekeeping.yaml b/.github/workflows/housekeeping.yaml index 160769b71c9..d89a45f63f1 100644 --- a/.github/workflows/housekeeping.yaml +++ b/.github/workflows/housekeeping.yaml @@ -69,7 +69,7 @@ jobs: continue-on-error: true uses: pre-commit/action@v2.0.3 - - name: (re)generate docs + - name: update versions in docs run: | for train in stable incubator develop non-free deprecated; do for chart in charts/${train}/*; do @@ -87,6 +87,11 @@ jobs: --output-file="CONFIG.md" \ --template-files="/home/runner/work/apps/apps/templates/docs/CONFIG.md.gotmpl" \ --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 done done diff --git a/templates/docs/CONFIG.md.gotmpl b/templates/docs/CONFIG.md.gotmpl index 3d59a05ac38..5e503c64ed5 100644 --- a/templates/docs/CONFIG.md.gotmpl +++ b/templates/docs/CONFIG.md.gotmpl @@ -1,7 +1,6 @@ {{- define "custom.custom.configuration.header" -}} # Configuration Options {{- end -}} - {{- define "custom.custom.configuration" -}} {{ template "custom.custom.configuration.header" . }} @@ -13,5 +12,4 @@ https://truecharts.org/manual/Quick-Start%20Guides/14-linking-apps/ ##### Available config options In the future this page is going to contain an automated list of options available in the installation/edit UI. {{- end -}} - {{ template "custom.custom.configuration" . }} diff --git a/templates/docs/README.md.gotmpl b/templates/docs/README.md.gotmpl index b7ebaf694ea..e73bfc280dc 100644 --- a/templates/docs/README.md.gotmpl +++ b/templates/docs/README.md.gotmpl @@ -1,53 +1,42 @@ {{- define "custom.introheader" -}} # Introduction {{- end -}} - {{- define "custom.repository.organization" -}} TrueCharts {{- end -}} - {{- define "custom.repository.url" -}} https://github.com/truecharts/apps {{- end -}} - {{- define "custom.helm.url" -}} https://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/apps/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 this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/03-Installing-an-App/). - {{- end -}} - {{- define "custom.uninstall" -}} ## 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/). {{- end -}} - {{- define "custom.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) - Ask a [question](https://github.com/truecharts/apps/discussions) {{- end -}} - {{- define "custom.copyright" -}} All Rights Reserved - The TrueCharts Project {{- end -}} - {{ template "custom.introheader" . }} {{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} diff --git a/templates/docs/app-readme.md.gotmpl b/templates/docs/app-readme.md.gotmpl index 3e472db12af..c73996a8c52 100644 --- a/templates/docs/app-readme.md.gotmpl +++ b/templates/docs/app-readme.md.gotmpl @@ -1,10 +1,8 @@ {{- define "custom.custom.app-readme" -}} {{ template "chart.deprecationWarning" . }} + {{ template "chart.description" . }} This App is supplied by TrueCharts, for more information please visit https://truecharts.org - {{- end -}} - - {{ template "custom.custom.app-readme" . }}