Files
charts/.github/SUPPORT.md
Stavros Kois 12b5c56b24 chore(docs): lints some docs, uses front-matter instead of # h1, and fix list items in changelog (#16589)
**Description**
<!--
Please include a summary of the change and which issue is fixed. Please
also include relevant motivation and context. List any dependencies that
are required for this change.
-->
⚒️ Fixes  # <!--(issue)-->

front matter is supported by all doc sites (including github markdown
rendering
and is easier to add extra metadata later on, if we want to.

```
---
title: sometitle
---
```

**⚙️ Type of change**

- [ ] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code

**🧪 How Has This Been Tested?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [ ] ⚖️ My code follows the style guidelines of this project
- [ ] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [ ] 📄 I have made corresponding changes to the documentation
- [ ] ⚠️ My changes generate no new warnings
- [ ] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [ ] ⬆️ I increased versions for any altered app according to semantic
versioning

** App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🪞 I have opened a PR on
[truecharts/containers](https://github.com/truecharts/containers) adding
the container to TrueCharts mirror repo.
- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._
2023-12-31 16:24:05 +02:00

4.9 KiB

title, sidebar_position
title sidebar_position
Support Policy 3

TrueCharts on TrueNAS SCALE

TrueCharts aims to always support the latest version of TrueNAS SCALE. However, sometimes new versions of either TrueNAS or TrueCharts introduces breaking changes. This document highlights which versions of TrueCharts (or rather branches), support which versions of TrueNAS SCALE.

We also document which versions of TrueNAS will receive TrueCharts updates and for which versions we are accepting bug reports.

Supported Versions of TrueNAS SCALE

TrueNAS version Branch Supported with updates Accepting Support tickets Accepting Bug Reports Notes
22.12.4.2 or prior master Update to 23.10.X Supported Version TrueNAS SCALE
23.10.0.1 master Update to 23.10.1 TrueNAS SCALE
23.10.1 master Stable Release as of 2023-12-19
Nightly master Please only submit bug reports during code-freeze

TrueCharts on Talos-OS

Support for Talos-OS with either Rancher or FluxCD are in early alpha.

Supported Versions of Talos-OS

Talos-OS version Branch Supported with updates Accepting Support tickets Accepting Bug Reports Notes
1.5 master
1.6 master

Supported Versions of FluxCD

FluxCD version Branch Supported with updates Accepting Support tickets Accepting Bug Reports Notes
1.2.1 or prior master

Rancher Versions of Rancher

TrueNAS version Branch Supported with updates Accepting Support tickets Accepting Bug Reports Notes
v2.7.9 or prior master

:::warning Support Guidelines

Our Discord support (the ticketing system inside #support) is primarily limited to what is covered by our written guides. This includes installing, linking and editing apps. This doesn't mean the actual setup of the application. All #support tickets covered by the staff are done so in a best effort policy.

:::

Stable Train Charts

We provide direct support for getting stable train charts working on our discord inside the #support channel. That includes installation and guidance on getting it working with defaults or basic settings (not advanced customizations or remote smb shares, etc). Bug reports aren't accepted on discord so if you spot a bug (Charts in the stable train should work with mostly defaults configuration) please report them to our github. Bug reports that state something doesn't work without supporting items may be closed.

Incubator Train Charts

Our support policy for incubator train charts is different for those on the stable train. Those charts are work in progress, may break at anytime and we're still going through many of the charts from unRAID. We won't accept support tickets for incubator train charts on our discord. However, we have an #incubator-chat channel for these apps to help get them running and/or receive feedback. With enough positive feedback a chart can be promoted to stable train. Feedback about bugs is also accepted there which can be used to fix them. Assume anything in the incubator train is in beta and you're testing it. As well, anything installed in incubator will have to be REINSTALLED once it moves to the stable train.