Commit Graph

37 Commits

Author SHA1 Message Date
Stavros Kois 698622495c
chore(docs): standardize ./img references (#16704)
**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-12-31 22:39:31 +02:00
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
nautilus7 ae24d09406
Update some links in the docs (#9839)
**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
- [x] 🪛 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
- [x] 👀 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
- [x] ⚠️ 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-06-23 08:53:11 +02:00
Kjeld Schouten-Lebbing 88b1a91c64
Create index.md
Signed-off-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
2022-11-20 20:15:49 +01:00
Kjeld Schouten-Lebbing 5864fce3ac
WIP Cleanup configuration options (#4365)
* chore(apps): remove un-needed UI elements

* dont grab metallb upstreams anymore

* add new readme template pointing to the website and remove helm-values system

* Move readme generation to daily job

* remove readme addition and remve readme generation from build-release script

* bump

* remvoe the use of helm-docs

* completely remove helm-docs

* move tag sync to renovate bump action

* fully remove tag sync and remove needless helm dependency updates

* remove needless helm prep

* get rid of needlessly loaded grafana repo
2022-11-10 16:46:44 +01:00
Jesperbelt ad4b8de878
Update Common library URL (#4153)
It seems this one has been overseen :).

Signed-off-by: Jesperbelt <70942135+Jesperbelt@users.noreply.github.com>

Signed-off-by: Jesperbelt <70942135+Jesperbelt@users.noreply.github.com>
2022-10-22 01:05:25 +02:00
Kjeld Schouten-Lebbing faa505e041
remove version badges from readmes and adapt links 2022-09-22 13:31:43 +02:00
Kjeld Schouten-Lebbing efe68723fc
Update README.md.gotmpl
Signed-off-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
2022-09-04 00:12:05 +02:00
Stavros Kois a7652a487b
fix(docs): correctly set the train in link (#3534) 2022-08-22 19:46:38 +03:00
Stavros Kois 7cd258678f
fix(docs): fix links (#3362)
* fix(docs): fix links

* update report to charts

* update some references from apps -> charts
2022-08-08 23:57:58 +02:00
Kjeld Schouten-Lebbing 20309bfaa2
Update README.md.gotmpl 2022-08-02 11:23:26 +02:00
StevenMcElligott 635e29627b
Fixed Readme links (#3262) 2022-07-22 18:19:56 +02:00
Kjeld Schouten-Lebbing d0f870e4d3
re-add version badges for fancyfancy 2022-07-19 14:03:28 +02:00
Kjeld Schouten-Lebbing 2b3ab65c26
fix(docs): fix broken readme 2022-07-19 14:00:53 +02:00
Kjeld Schouten-Lebbing 356b0e1dee
feat(ci): improve chart readme and scale description. 2022-07-19 13:53:25 +02:00
Stavros Kois 86facb67e7
chore(docs): fix headers for better table of contents (#3217)
Co-authored-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
2022-07-19 13:16:16 +02:00
Kjeld Schouten-Lebbing 2857446d84
push template fix 2022-07-19 13:16:03 +02:00
Kjeld Schouten-Lebbing 8017edcb49
chore: ReadmeCI is barfing 2022-07-19 12:22:48 +02:00
Kjeld Schouten-Lebbing 25e58b97d2
fixes 2022-07-19 12:14:13 +02:00
Kjeld Schouten-Lebbing 74db8dd910
fix(mosquitto): set password file when auth is enabled (#3216)
* fix(mosquitto): set password file when auth is enabled

* Update Chart.yaml

* Update README.md.gotmpl
2022-07-19 11:42:12 +02:00
Stavros Kois 837718944d
chore(docs): changes to CI doc generation (#3153)
* chore(docs): changes to CI doc generation

* remove comment

* copy icon.png to website

* rename to chart-icons

* ensure the correct paths exists

* remove per app licenses

* Apply suggestions from code review

* Update .github/workflows/charts-release.yaml

* Update .github/workflows/charts-release.yaml

* Update .github/workflows/charts-release.yaml

* update CHANGELOG tpl

* another version

* space between `---`

* Update .github/workflows/charts-release.yaml

Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>

Co-authored-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
2022-07-12 22:38:48 +02:00
Kjeld Schouten-Lebbing 820937fee2
fix typo 2022-07-12 18:54:35 +02:00
Kjeld Schouten-Lebbing fcfa8df978
Update README.md.gotmpl 2022-07-11 23:13:55 +02:00
Kjeld Schouten-Lebbing f7128389d9
Delete CONFIG.md.gotmpl 2022-07-11 23:12:48 +02:00
Kjeld Schouten-Lebbing 0aebe38cc5
Update README.md.gotmpl 2022-07-11 23:11:19 +02:00
kjeld Schouten-Lebbing 6ffc74ca21
chore(common): remove common testing and such 2022-03-26 11:42:28 +01:00
Stavros Kois bad16311ab
fix(docs): Update internal dns generator and fix some 404 links (#2212)
* fix(docs): Update internal dns generator

* update some links

* one more
2022-03-18 21:56:45 +01:00
Konrad Bujak 035012428c
adding quick-start guide as a link (#2199)
* adding quick-start guide as a link

* modyfing default files
2022-03-18 13:53:15 +01:00
kjeld Schouten-Lebbing 85b84b7af0
Fix copyright header and common docs copying 2021-08-31 12:21:54 +02:00
kjeld Schouten-Lebbing 48f6102ac9
fix a small mistake and limit common updates to tuesday 2021-08-31 12:05:39 +02:00
kjeld Schouten-Lebbing e250c0a0b8
generate common docs (+1 squashed commits)
Squashed commits:

[0f1f76b1f] again
2021-08-31 11:41:59 +02:00
kjeld Schouten-Lebbing b6bfd838da
Add default values.yaml documentation and remove version from docs to prevent version bloat 2021-08-31 11:07:48 +02:00
kjeld Schouten-Lebbing 91990dcac4
don't include deprication warning in app-readme due to whitespace issues 2021-08-19 12:23:08 +02:00
kjeld Schouten-Lebbing 1e7d1d5083
Fix some docs bugs 2021-08-19 12:15:14 +02:00
kjeld Schouten-Lebbing 06ac2acd58
fix app-readme template 2021-08-19 12:00:08 +02:00
kjeld Schouten-Lebbing 6747c12783
add app-readme generation again (it got lost somehow) 2021-08-19 11:55:12 +02:00
kjeld Schouten-Lebbing ff9eb17b28
cleanup tools, templates and workflows 2021-08-19 11:47:00 +02:00