Skip to content

Commit

Permalink
Fix app-template Chart links (#29827)
Browse files Browse the repository at this point in the history
**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)-->
-Fix App-template Chart.yaml url links

**⚙️ 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
- [x ] 📄 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
- [ ] 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
itconstruct authored Dec 18, 2024
1 parent 56a1632 commit 29d8cfc
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions website/src/content/docs/development/chart-yaml-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Chart.yaml layout
---

At TrueCharts we try to keep some files standardized, this enables us to make changes to these charts in bulk with less risk of mistakes. Chart.yaml is one of these files.
In this documentation we will explain the standardized layout options. For an example layout, please see our standard Chart.yaml [template](https://github.com/truecharts/charts/blob/master/templates/chart/Chart.yaml)
In this documentation we will explain the standardized layout options. For an example layout, please see our standard Chart.yaml [template](https://github.com/truecharts/public/blob/master/charts/premium/app-template/Chart.yaml)

## Layout Explained

Expand Down Expand Up @@ -45,7 +45,7 @@ annotations:
In the above description there are a lot of values that are not actually used. Some of those, like `deprecated`, we just set to false. While others, like `annotations` get commented out.

Please refer to our standard Chart.yaml [template](https://github.com/truecharts/charts/blob/master/templates/chart/Chart.yaml) to see which unused values needs which treatment.
Please refer to our standard Chart.yaml [template](https://github.com/truecharts/public/blob/master/charts/premium/app-template/Chart.yaml) to see which unused values needs which treatment.

### Dependencies

Expand All @@ -56,4 +56,4 @@ All other dependencies are expected to be listed in alphabetical order.
### Maintainers

The only maintainer should always be TrueCharts, as the TrueCharts core team is expected to step in if the other maintainers fail to maintain their work.
An example of how to list TrueCharts as a maintainer is available in our standard Chart.yaml [template](https://github.com/truecharts/charts/blob/master/templates/chart/Chart.yaml).
An example of how to list TrueCharts as a maintainer is available in our standard Chart.yaml [template](https://github.com/truecharts/public/blob/master/charts/premium/app-template/Chart.yaml).

0 comments on commit 29d8cfc

Please sign in to comment.