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

charts/truecommand/1.3.0/README.md

@@ -1,5 +0,0 @@
-# Truecommand helm chart
-
-## Configuration
-
-Please refer to questions.yaml for a detailed overview on supported configurable items.

charts/truecommand/1.3.0/app-readme.md

@@ -1,3 +0,0 @@
-# Truecommand
-
-Truecommand chart is a chart designed to deploy Truecommand in a TrueNAS SCALE kubernetes cluster.

charts/truecommand/1.3.1/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 appVersion: 1.3.2
 description: Aggregated management of TrueNAS devices
 name: truecommand
-version: 1.3.0
+version: 1.3.1
 keywords:
   - truecommand
 home: https://github.com/truecharts/charts/tree/dev/charts/truecommand

charts/truecommand/1.3.1/README.md

@@ -0,0 +1,51 @@
+# Introduction
+
+![Version: 1.3.1](https://img.shields.io/badge/Version-1.3.1-informational?style=flat-square) ![AppVersion: 1.3.2](https://img.shields.io/badge/AppVersion-1.3.2-informational?style=flat-square)
+
+Aggregated management of TrueNAS devices
+
+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)**
+
+## Source Code
+
+* <https://github.com/Truecommand/Truecommand>
+* <https://hub.docker.com/r/ixsystems/truecommand>
+
+## Requirements
+
+## Dependencies
+
+| Repository | Name | Version |
+|------------|------|---------|
+| https://charts.truecharts.org/ | common | 1.3.0 |
+
+## Installing the Chart
+
+To install the chart with the release name `truecommand`
+
+- Open TrueNAS SCALE
+- Go to Apps
+- Click "Install" for this specific Apps
+- Fill out the configuration form
+
+## Uninstalling the Chart
+
+To uninstall the `truecommand` 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.
+
+## 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)
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)

charts/truecommand/1.3.1/README.md.gotmpl

@@ -0,0 +1,95 @@
+{{- 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" . }}

charts/truecommand/1.3.1/app-readme.md

@@ -0,0 +1 @@
+Aggregated management of TrueNAS devices

charts/truecommand/1.3.1/app-readme.md.gotmpl

@@ -0,0 +1,5 @@
+{{- define "custom.notes" -}}
+{{- end -}}
+
+{{ template "chart.description" . }}
+{{ template "custom.notes" . }}

charts/truecommand/1.3.1/docs/CONFIG.md

@@ -0,0 +1,3 @@
+# Configuration Options
+
+N/A

charts/truecommand/1.3.1/docs/CONFIG.md.gotmpl

@@ -0,0 +1,11 @@
+{{- define "custom.custom.configuration.header" -}}
+# Configuration Options
+{{- end -}}
+
+{{- define "custom.custom.configuration" -}}
+{{ template "custom.custom.configuration.header" . }}
+
+N/A
+{{- end -}}
+
+{{ template "custom.custom.configuration" . }}

charts/truecommand/1.3.1/questions.yaml

@@ -111,8 +111,8 @@ questions:
                 label: "Value"
                 schema:
                   type: string
-      
-                  
+
+
   # Enable Host Network
   - variable: hostNetwork
     group: "Networking"
@@ -120,7 +120,7 @@ questions:
     schema:
       type: boolean
       default: false
-      
+
   - variable: service
     group: "Networking"
     label: "Configure Service"
@@ -189,7 +189,7 @@ questions:
                 schema:
                   type: boolean
                   default: true
-                  hidden: false 
+                  hidden: false
               - variable: emptyDir
                 label: "emptyDir"
                 schema:
@@ -321,4 +321,4 @@ questions:
                       label: "Forward Authentication URL"
                       schema:
                         type: string
-                        default: ""
+                        default: ""

charts/truecommand/1.3.1/test_values.yaml

@@ -47,4 +47,4 @@ appVolumeMounts:
     enabled: true
     emptyDir: true
     setPermissions: true
-    mountPath: "/data"
+    mountPath: "/data"