chore: Auto-update chart README [skip ci]

charts/stable/syslog-ng/README.md

@@ -4,13 +4,7 @@
 
 syslog-ng allows you to flexibly collect, parse, classify, rewrite and correlate logs.
 
-**Homepage:** <https://github.com/k8s-at-home/charts/tree/master/charts/stable/syslog-ng>
+**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
-
-## Maintainers
-
-| Name | Email | Url |
-| ---- | ------ | --- |
-| simoncaron | simon.caron@protonmail.com |  |
 
 ## Source Code
 
@@ -20,12 +14,65 @@ syslog-ng allows you to flexibly collect, parse, classify, rewrite and correlate
 
 Kubernetes: `>=1.16.0-0`
 
+## Dependencies
+
 | Repository | Name | Version |
 |------------|------|---------|
 | https://library-charts.k8s-at-home.com | common | 4.4.2 |
 
+## TL;DR
+
+```console
+helm repo add k8s-at-home https://k8s-at-home.com/charts/
+helm repo update
+helm install syslog-ng k8s-at-home/syslog-ng
+```
+
+## Installing the Chart
+
+To install the chart with the release name `syslog-ng`
+
+```console
+helm install syslog-ng k8s-at-home/syslog-ng
+```
+
+## Uninstalling the Chart
+
+To uninstall the `syslog-ng` deployment
+
+```console
+helm uninstall syslog-ng
+```
+
+The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
+
+## Configuration
+
+Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
+Other values may be used from the [values.yaml](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common).
+
+Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
+
+```console
+helm install syslog-ng \
+  --set env.TZ="America/New York" \
+    k8s-at-home/syslog-ng
+```
+
+Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
+
+```console
+helm install syslog-ng k8s-at-home/syslog-ng -f values.yaml
+```
+
+## Custom configuration
+
+N/A
+
 ## Values
 
+**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common)
+
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | env | object | See below | environment variables. See more environment variables in the [syslog-ng documentation](https://syslog-ng.org/docs). |
@@ -33,10 +80,37 @@ Kubernetes: `>=1.16.0-0`
 | env.PUID | string | `"1001"` | Set the container user id |
 | env.TZ | string | `"UTC"` | Set the container timezone |
 | image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
-| image.repository | string | `"linuxserver/syslog-ng"` | image repository |
+| image.repository | string | `"ghcr.io/linuxserver/syslog-ng"` | image repository |
-| image.tag | string | `"3.30.1"` | image tag |
+| image.tag | string | chart.appVersion | image tag |
 | persistence | object | See values.yaml | Configure persistence settings for the chart under this key. |
 | service | object | See values.yaml | Configures service settings for the chart. |
 
+## Changelog
+
+### Version 1.0.0
+
+#### Added
+
+* Initial version
+
+#### Changed
+
+N/A
+
+#### Fixed
+
+N/A
+
+### Older versions
+
+A historical overview of changes can be found on [ArtifactHUB](https://artifacthub.io/packages/helm/k8s-at-home/syslog-ng?modal=changelog)
+
+## Support
+
+- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
+- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
+- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
+- Join our [Discord](https://discord.gg/sTMX7Vh) community
+
 ----------------------------------------------
 Autogenerated from chart metadata using [helm-docs v0.1.1](https://github.com/k8s-at-home/helm-docs/releases/v0.1.1)