Cloned2Preserve
/
TrueChartsClone
mirror of https://github.com/truecharts/charts.git
1
0
Fork 0
Code
TrueChartsClone/.github/SUPPORT.md

49 lines
4.7 KiB
Markdown
Raw Normal View History

add sidebar position to support page (#8493) **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. --> add position to support page, almost forgot that this page gets copied to truecharts/website so the change to that page would just be overwritten without the position set in this SUPPORT.md page header. ⚒️ Fixes # <!--(issue)--> **⚙️ 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-04-30 04:15:29 -04:00
---
sidebar_position: 3
---
fix(Docs): Add info to Support.md (#3457) * add support.md on gh * might as well add changes here * format * added a large FAQ section * Make some changes + formatting * Update .github/SUPPORT.md * Update .github/SUPPORT.md * Apply suggestions from code review * Update .github/SUPPORT.md Co-authored-by: Stavros kois <s.kois@outlook.com> Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com> Co-authored-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
2022-08-13 04:49:06 -04:00
# Support Policy
## 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
| TrueNAS version | Branch | Supported with updates | Accepting Support tickets | Accepting Bug Reports | Notes |
Add Plex Installation Notes (#9052) **Description** Created Installation Notes for Plex ⚒️ Fixes # **⚙️ 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?** **📃 Notes:** **✔️ 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._ --------- Signed-off-by: kqmaverick <121722567+kqmaverick@users.noreply.github.com> Signed-off-by: Kjeld Schouten <kjeld@schouten-lebbing.nl> Signed-off-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com> Co-authored-by: StevenMcElligott <89483932+StevenMcElligott@users.noreply.github.com> Co-authored-by: Stavros kois <s.kois@outlook.com> Co-authored-by: Kjeld Schouten <kjeld@schouten-lebbing.nl> Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
2023-05-22 15:19:19 -04:00
| ---------------- | -------- | ---------------------- | ------------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------- |
| 22.02.4 or prior | `master` | :x: | :x: | :x: | Advised to update to 22.12.2 release of [TrueNAS SCALE](https://www.truenas.com/docs/scale/scalereleasenotes/) |
| 22.12.0 | `master` | :white_check_mark: | :white_check_mark: | :white_check_mark: | Stable Release as of 2022-12-13 |
| 22.12.1 | `master` | :white_check_mark: | :white_check_mark: | :white_check_mark: | Stable Release as of 2023-02-21 |
| 22.12.2 | `master` | :white_check_mark: | :white_check_mark: | :white_check_mark: | Stable Release as of 2023-04-11 |
docs(support): add 22.12.3 (#11207) **Description** Added 22.12.3 and its fixes. Left recommenedation to only upgrade to 22.12.2 due to the ongoing ix-systems bug. ⚒️ Fixes # **⚙️ 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?** **📃 Notes:** **✔️ 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-08-06 04:28:09 -04:00
| 22.12.3 | `master` | :white_check_mark: | :white_check_mark: | :white_check_mark: | Stable Release as of 2023-06-13 |
| 22.12.3.1 | `master` | :white_check_mark: | :white_check_mark: | :white_check_mark: | Stable Release as of 2023-06-20 |
| 22.12.3.2 | `master` | :white_check_mark: | :white_check_mark: | :white_check_mark: | Stable Release as of 2023-07-05 |
| 22.12.3.3 | `master` | :white_check_mark: | :white_check_mark: | :white_check_mark: | Stable Release as of 2023-07-25 |
update support doc
2022-08-25 10:38:56 -04:00
| Nightly | `master` | :white_check_mark: | :x: | :white_check_mark: | Please only submit bug reports during codefreeze |
feat(cert-manager): add Cert-Manager configuration App (#6378) * feat(cert-manager): add Cert-Manager configuration App * eof * pre-commit cleanup * add temp crds folder * patch mistake * restructure * add route53 support * add some fails * fixes and add route53 to GUI * end * add experimental HTTP01 support * fix bug * add buypass acme to dropdown * add akamai support * add Digitalocean * add rfc2136 support * fix some issues and add self-signed issuer * add metrics and fix selfsigned * whoops * Add CA certificate system * whoops * benc stuff * actually load CA * fix * fix ca * bool -> boolean * also test CA * wait for pod to be ready * sleep more agressively on cert-Manger itself * some more fixes * whoops * fix mistakes * all waits test * add cmctl * increase scope for now and some fixes * simplify * dont wait on non-existing pods * make it non-failing * fix typo
2023-01-17 18:06:10 -05:00
fix(github): Update SUPPORT.md for SCALE versions (#7806) **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)--> **⚙️ 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-03-18 17:24:14 -04:00
:::warning Support Guidelines
fix(Docs): Update SUPPORT.md to remove 22.02.4 (#6074) * fix(Docs): Update SUPPORT.md to remove 22.02.4 * Added Support Guidelines
2023-01-07 16:18:27 -05:00
Our [Discord](https://discord.gg/tVsPTHWTtr) 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.
:::
fix(Docs): Add info to Support.md (#3457) * add support.md on gh * might as well add changes here * format * added a large FAQ section * Make some changes + formatting * Update .github/SUPPORT.md * Update .github/SUPPORT.md * Apply suggestions from code review * Update .github/SUPPORT.md Co-authored-by: Stavros kois <s.kois@outlook.com> Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com> Co-authored-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
2022-08-13 04:49:06 -04:00
## Stable Train Charts
We provide direct support for getting `stable` train charts working on our [discord](https://discord.gg/tVsPTHWTtr) inside the **#support** channel.
That includes installation and guidance on getting it working with defaults or basic settings (not advanced customisations or remote smb shares, etc).
update support doc
2022-08-25 10:38:56 -04:00
Bug reports aren't accepted on [discord](https://discord.gg/tVsPTHWTtr) so if you spot a bug (Charts in the stable train should work with mostly defaults configuration)
fix(Docs): Add info to Support.md (#3457) * add support.md on gh * might as well add changes here * format * added a large FAQ section * Make some changes + formatting * Update .github/SUPPORT.md * Update .github/SUPPORT.md * Apply suggestions from code review * Update .github/SUPPORT.md Co-authored-by: Stavros kois <s.kois@outlook.com> Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com> Co-authored-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
2022-08-13 04:49:06 -04:00
please report them to our [github](https://github.com/truecharts/charts/issues/new/choose). Bug reports that state something doesn't work without supporting items may be closed.
## Incubator Train Charts
update support doc
2022-08-25 10:38:56 -04:00
Our support policy for `incubator` train charts is different for those on the `stable` train. Those charts are work in progress,
add all supported versions and correct spelling (#8144) **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. --> add all supported versions and correct spelling and remove duplicated words. This PR is necessary as previous PR merged on website was overwritten by an automated job that copies SUPPORT.md to the website at docs/manual/SUPPORT.md. ⚒️ Fixes # <!--(issue)--> **⚙️ 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 --> viewable at https://truecharts-review.netlify.app/docs/manual/support/ **📃 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-04-26 05:32:52 -04:00
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](https://discord.gg/tVsPTHWTtr). 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.
update support doc
2022-08-25 10:38:56 -04:00
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.