Skip to content

Commit

Permalink
docs(support-policy): updates support policy (#29304)
Browse files Browse the repository at this point in the history
**Description**
Updates support policy documentation.

⚒️ 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
- [X] I made sure the title starts with `feat(chart-name):`,
`fix(chart-name):` or `chore(chart-name):`

**➕ App addition**

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

- [ ] 🖼️ 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._
  • Loading branch information
kqmaverick authored Nov 13, 2024
1 parent a470f81 commit 9f280a0
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions website/src/content/docs/general/support-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ Please, always remember to check the content specific to the chart.

TrueCharts is a comprehensive project that focuses on providing opinionated Helm charts for applications to run on Kubernetes-based platforms.

We also offer free support via a support-ticketing system on Discord, according to the policy layed out in this document.
We also offer free support via a support-ticketing system on Discord, according to the policy laid out in this document.

## Support Rules

- If its covered by support as outlined below make a ticket in [⁠🎫・support](https://discord.com/channels/830763548678291466/936275413179723826).
- [⁠🎫・support](https://discord.com/channels/830763548678291466/936275413179723826) is not rendered on GitHub or any other platform.
- Bugs must be reported on GitHub, but only after confirmation by the staff via a [⁠🎫・support ticket](https://discord.com/channels/830763548678291466/936275413179723826)
- Anything not covered by the below Support Policy is not eligble for a [⁠🎫・support ticket](https://discord.com/channels/830763548678291466/936275413179723826). If you need assitance outside the scuoe of [⁠🎫・support](https://discord.com/channels/830763548678291466/936275413179723826) make a thread in an appropiate [Discord Channel](https://discord.gg/tVsPTHWTtr).
- Anything not covered by the below Support Policy is not eligible for a [⁠🎫・support ticket](https://discord.com/channels/830763548678291466/936275413179723826). If you need assistance outside the scope of [⁠🎫・support](https://discord.com/channels/830763548678291466/936275413179723826) make a thread in an appropriate [Discord Channel](https://discord.gg/tVsPTHWTtr).
- We help out where we can, as long as you tried to do it yourself *first*. We do not provide a walkthrough service.
- Our staff will try to help out with providing instructions on how to use `kubectl` and other `*ctl` tools where needed.
- Please be aware that the code of conduct also applies to all support.
Expand All @@ -37,19 +37,20 @@ We also offer free support via a support-ticketing system on Discord, according
- We do provide support for issues regarding talconfig.yaml, as long as ClusterTool is used for the deployment.
- We do provide *basic* assistance with [Talos OS](../guides/talos/), when deployed or maintained through ClusterTool (upgrades, config changes etc)
- We do provide support for FluxCD setup and layout, as long as ClusterTool is used for the deployment.
- We *only* provide support for the latest version of ClusterTool. Please ensure you are utilizing the latest version before requesting support.

## Kubernetes Support Policy

- We do not offer support for any component of kubernets that is not made by TrueCharts.
- This includes charts by other parties or manually created kubernetes manifests and deployments.
- We do not offer support for any component of kubernets that is not made by TrueCharts.

## Helm Chart Support Policy

- We offer support for all features available in our helm-charts, including all options in the common-chart.
- We offer [basic documentation](../guides/helm/) and support for installing, upgrading and editing our Helm-Charts using Helm.
- We do not support external secret management outside of values.yaml
- We offer support for all our charts trains, except `incubator`, `dev`, and `test`.
- We cannot guarantee special characters will work flawlessly in any field.

:::note

Expand All @@ -59,9 +60,10 @@ Some [(common-chart)](../common/) features might not work correctly with all cha

## FluxCD Support Policy

- We offer support for our Helm-Charts values in FLuxCD as outlined in Helm Chart Support.
- We offer support for our Helm-Charts values in FluxCD as outlined in Helm Chart Support.
- We offer [basic documentation](../guides/fluxcd/) and support on how to create a `helm-release` file, to deploy our helm-charts on Flux.
- We offer support for our Helm-Charts values in FLuxCD as outlined in Helm Chart Support.
- To be eligible for FluxCD support your repository must be public.
- All information being provided *must* be un-encrypted. You can obfuscate any sensitive information as needed.

## What's Explicitly Not Covered By Support

Expand Down

0 comments on commit 9f280a0

Please sign in to comment.