Cloned2Preserve
/
TrueChartsClone
mirror of https://github.com/truecharts/charts.git
1
0
Fork 0
Code
TrueChartsClone/templates/docs/README.md.gotmpl

72 lines
2.3 KiB
Go Template
Raw Normal View History

777 on new scripts (+2 squashed commit) 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
2021-02-23 17:21:54 +00:00
{{- define "custom.introheader" -}}
# Introduction
{{- end -}}
{{- define "custom.repository.organization" -}}
TrueCharts
{{- end -}}
{{- define "custom.repository.url" -}}
Testing, BugFixes and Review Improvements - Fix SabNZBD hostname whitelist issues - Add transmission settings to GUI - Fix some qbittorrent connection issues - Remove Torrent Ingress - Fix some device mounting gui issues - Change repo url references - Cleaning up the homepage - Drop Deluge (App is not safe due to being mostly abandoned) - Move Emby to own Non-Root container - Create new trains and move charts->stable - Add Plex app - update emby and plex intel hardware support - Implement new parallel CI for Apps - Move PGID, PUID, TZ and UMASK settings to "Container Image" configuration - Stop running some workflows on staging - Add branch security trigger to matrix workflows Co-authored-by: Troy Prelog <35702532+tprelog@users.noreply.github.com>
2021-03-17 16:20:26 +00:00
https://github.com/truecharts/apps
777 on new scripts (+2 squashed commit) 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
2021-02-23 17:21:54 +00:00
{{- end -}}
{{- define "custom.helm.url" -}}
readme template polishing
2021-08-19 09:38:55 +00:00
https://truecharts.org
777 on new scripts (+2 squashed commit) 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
2021-02-23 17:21:54 +00:00
{{- 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.
Testing, BugFixes and Review Improvements - Fix SabNZBD hostname whitelist issues - Add transmission settings to GUI - Fix some qbittorrent connection issues - Remove Torrent Ingress - Fix some device mounting gui issues - Change repo url references - Cleaning up the homepage - Drop Deluge (App is not safe due to being mostly abandoned) - Move Emby to own Non-Root container - Create new trains and move charts->stable - Add Plex app - update emby and plex intel hardware support - Implement new parallel CI for Apps - Move PGID, PUID, TZ and UMASK settings to "Container Image" configuration - Stop running some workflows on staging - Add branch security trigger to matrix workflows Co-authored-by: Troy Prelog <35702532+tprelog@users.noreply.github.com>
2021-03-17 16:20:26 +00:00
**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)**
777 on new scripts (+2 squashed commit) 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
2021-02-23 17:21:54 +00:00
{{- end -}}
{{- define "custom.requirements" -}}
## Requirements
{{ template "chart.kubeVersionLine" . }}
{{- end -}}
{{- define "custom.dependencies" -}}
## Dependencies
{{ template "chart.requirementsTable" . }}
{{- end -}}
{{- define "custom.install" -}}
## Installing the Chart
fix(docs): Update internal dns generator and fix some 404 links (#2212) * fix(docs): Update internal dns generator * update some links * one more
2022-03-18 20:56:45 +00:00
To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/02-Installing-an-App/).
777 on new scripts (+2 squashed commit) 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
2021-02-23 17:21:54 +00:00
{{- end -}}
{{- define "custom.uninstall" -}}
fix(docs): Update internal dns generator and fix some 404 links (#2212) * fix(docs): Update internal dns generator * update some links * one more
2022-03-18 20:56:45 +00:00
## Upgrading, Rolling Back and Uninstalling the Chart
777 on new scripts (+2 squashed commit) 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
2021-02-23 17:21:54 +00:00
fix(docs): Update internal dns generator and fix some 404 links (#2212) * fix(docs): Update internal dns generator * update some links * one more
2022-03-18 20:56:45 +00:00
To upgrade, rollback or delete this App from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/04-Upgrade-rollback-delete-an-App/).
777 on new scripts (+2 squashed commit) 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
2021-02-23 17:21:54 +00:00
{{- end -}}
{{- define "custom.support" -}}
## Support
fix(docs): Update internal dns generator and fix some 404 links (#2212) * fix(docs): Update internal dns generator * update some links * one more
2022-03-18 20:56:45 +00:00
- Please check our [quick-start guides](https://truecharts.org/manual/Quick-Start%20Guides/01-Adding-TrueCharts/) first.
Post Code-Freeze Review, Bugsfixes and Documentation - Fix traefik Portal Button - Touchup Security Policies - Update Support Policies - Re-Add Deluge as incubator App - Add Canary to Security Policies - Add all-contributors basic config
2021-03-31 20:50:04 +00:00
- See the [Wiki](https://truecharts.org)
readme template polishing
2021-08-19 09:38:55 +00:00
- Check our [Discord](https://discord.gg/tVsPTHWTtr)
Testing, BugFixes and Review Improvements - Fix SabNZBD hostname whitelist issues - Add transmission settings to GUI - Fix some qbittorrent connection issues - Remove Torrent Ingress - Fix some device mounting gui issues - Change repo url references - Cleaning up the homepage - Drop Deluge (App is not safe due to being mostly abandoned) - Move Emby to own Non-Root container - Create new trains and move charts->stable - Add Plex app - update emby and plex intel hardware support - Implement new parallel CI for Apps - Move PGID, PUID, TZ and UMASK settings to "Container Image" configuration - Stop running some workflows on staging - Add branch security trigger to matrix workflows Co-authored-by: Troy Prelog <35702532+tprelog@users.noreply.github.com>
2021-03-17 16:20:26 +00:00
- Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
{{- end -}}
{{- define "custom.copyright" -}}
All Rights Reserved - The TrueCharts Project
777 on new scripts (+2 squashed commit) 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
2021-02-23 17:21:54 +00:00
{{- end -}}
{{ template "custom.introheader" . }}
{{ template "chart.description" . }}
add app-readme generation again (it got lost somehow)
2021-08-19 09:55:12 +00:00
{{ template "chart.deprecationWarning" . }}
777 on new scripts (+2 squashed commit) 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
2021-02-23 17:21:54 +00:00
{{ template "custom.notes" . }}
{{ template "chart.sourcesSection" . }}
{{ template "custom.requirements" . }}
{{ template "custom.dependencies" . }}
{{ template "custom.install" . }}
{{ template "custom.uninstall" . }}
{{ template "custom.support" . }}
generate common docs (+1 squashed commits) Squashed commits: [0f1f76b1f] again
2021-08-31 09:20:18 +00:00
---
Testing, BugFixes and Review Improvements - Fix SabNZBD hostname whitelist issues - Add transmission settings to GUI - Fix some qbittorrent connection issues - Remove Torrent Ingress - Fix some device mounting gui issues - Change repo url references - Cleaning up the homepage - Drop Deluge (App is not safe due to being mostly abandoned) - Move Emby to own Non-Root container - Create new trains and move charts->stable - Add Plex app - update emby and plex intel hardware support - Implement new parallel CI for Apps - Move PGID, PUID, TZ and UMASK settings to "Container Image" configuration - Stop running some workflows on staging - Add branch security trigger to matrix workflows Co-authored-by: Troy Prelog <35702532+tprelog@users.noreply.github.com>
2021-03-17 16:20:26 +00:00
{{ template "custom.copyright" . }}