From 77af3ebf004ef9efaf50026106a8d1c626f17715 Mon Sep 17 00:00:00 2001 From: Stavros Kois <47820033+stavros-k@users.noreply.github.com> Date: Sun, 14 Apr 2024 01:03:13 +0300 Subject: [PATCH] chore(docs): fix few more (#20721) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description** ⚒️ 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 - [ ] 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._ --- charts/incubator/peppermint/CHANGELOG.md | 2 - .../victoriametrics/docs/disclaimer.md | 2 - charts/premium/nextcloud/docs/support.md | 2 - charts/stable/gaseous-server/CHANGELOG.md | 4 +- charts/stable/immich/CHANGELOG.md | 68 ++----------------- charts/stable/immich/docs/install_notes.md | 4 +- charts/stable/maintainerr/CHANGELOG.md | 4 +- .../stable/nvidia-gpu-exporter/CHANGELOG.md | 4 +- charts/stable/ollama/CHANGELOG.md | 4 +- charts/stable/palworld/CHANGELOG.md | 4 +- .../stable/peanut/docs/installation-notes.md | 4 +- charts/stable/sftpgo/docs/plugins.md | 4 +- charts/stable/timetagger/docs/Install.md | 4 +- charts/stable/truenas-exporter/docs/setup.md | 4 +- charts/system/kubeapps/docs/token.md | 2 - .../nvidia-device-plugin/docs/installation.md | 2 +- 16 files changed, 36 insertions(+), 82 deletions(-) diff --git a/charts/incubator/peppermint/CHANGELOG.md b/charts/incubator/peppermint/CHANGELOG.md index 9811a1375f5..6afbcc5f802 100644 --- a/charts/incubator/peppermint/CHANGELOG.md +++ b/charts/incubator/peppermint/CHANGELOG.md @@ -1,5 +1,3 @@ --- title: Changelog --- - -# Changelog diff --git a/charts/incubator/victoriametrics/docs/disclaimer.md b/charts/incubator/victoriametrics/docs/disclaimer.md index dda4b532104..55bfb817888 100644 --- a/charts/incubator/victoriametrics/docs/disclaimer.md +++ b/charts/incubator/victoriametrics/docs/disclaimer.md @@ -2,8 +2,6 @@ title: Disclaimer --- -# Disclaimer/Warning - VictoriaMetrics is NOT compatible with any TrueCharts Helm Chart and not integrated into the platform, It's offered as a stand-alone chart only, it cannot be connected to any other chart offered by TrueCharts. We also do not support connecting this with any other charts offered by TrueCharts. It might, inherently, break other charts offered by TrueCharts. Use at your own risk. No support will be offered anymore for users running any form of Metrics (prometheus or otherwise) with this chart installed. diff --git a/charts/premium/nextcloud/docs/support.md b/charts/premium/nextcloud/docs/support.md index b0bbe38cb82..95908f9773f 100644 --- a/charts/premium/nextcloud/docs/support.md +++ b/charts/premium/nextcloud/docs/support.md @@ -2,8 +2,6 @@ title: NextCloud Support Policy --- -# Nextcloud Support Policy - Our support is only covering pre-included Nextcloud apps. We cannot guarantee user-added apps will work or survive updates We can also only support one "layout" or config.php setup (so no multisite) config.php should be considered non-user alterable. Users should write custom config files to append/override config.php instead. diff --git a/charts/stable/gaseous-server/CHANGELOG.md b/charts/stable/gaseous-server/CHANGELOG.md index 825c32f0d03..6afbcc5f802 100644 --- a/charts/stable/gaseous-server/CHANGELOG.md +++ b/charts/stable/gaseous-server/CHANGELOG.md @@ -1 +1,3 @@ -# Changelog +--- +title: Changelog +--- diff --git a/charts/stable/immich/CHANGELOG.md b/charts/stable/immich/CHANGELOG.md index 3243ef2c861..004e21c8ff3 100644 --- a/charts/stable/immich/CHANGELOG.md +++ b/charts/stable/immich/CHANGELOG.md @@ -1,12 +1,13 @@ -# Changelog - - +--- +title: Changelog +--- ## [immich-2.0.0](https://github.com/truecharts/charts/compare/immich-1.0.6...immich-2.0.0) (2022-11-10) ### Chore - Auto-update chart README [skip ci] + - Auto-update chart README [skip ci] - Auto-update chart README [skip ci] - Auto-update chart README [skip ci] @@ -22,9 +23,6 @@ - change container config label - - - ## [immich-1.0.9](https://github.com/truecharts/charts/compare/immich-1.0.6...immich-1.0.9) (2022-11-08) ### Chore @@ -39,9 +37,6 @@ - update helm general non-major ([#4349](https://github.com/truecharts/charts/issues/4349)) - update helm general non-major ([#4329](https://github.com/truecharts/charts/issues/4329)) - - - ## [immich-1.0.8](https://github.com/truecharts/charts/compare/immich-1.0.6...immich-1.0.8) (2022-11-08) ### Chore @@ -54,9 +49,6 @@ - update helm general non-major ([#4342](https://github.com/truecharts/charts/issues/4342)) - update helm general non-major ([#4329](https://github.com/truecharts/charts/issues/4329)) - - - ## [immich-1.0.8](https://github.com/truecharts/charts/compare/immich-1.0.6...immich-1.0.8) (2022-11-08) ### Chore @@ -68,9 +60,6 @@ - update helm general non-major ([#4342](https://github.com/truecharts/charts/issues/4342)) - update helm general non-major ([#4329](https://github.com/truecharts/charts/issues/4329)) - - - ## [immich-1.0.8](https://github.com/truecharts/charts/compare/immich-1.0.6...immich-1.0.8) (2022-11-08) ### Chore @@ -81,9 +70,6 @@ - update helm general non-major ([#4342](https://github.com/truecharts/charts/issues/4342)) - update helm general non-major ([#4329](https://github.com/truecharts/charts/issues/4329)) - - - ## [immich-1.0.7](https://github.com/truecharts/charts/compare/immich-1.0.6...immich-1.0.7) (2022-11-07) ### Chore @@ -92,9 +78,6 @@ - Auto-update chart README [skip ci] - update helm general non-major ([#4329](https://github.com/truecharts/charts/issues/4329)) - - - ## [immich-1.0.7](https://github.com/truecharts/charts/compare/immich-1.0.6...immich-1.0.7) (2022-11-06) ### Chore @@ -102,9 +85,6 @@ - Auto-update chart README [skip ci] - update helm general non-major ([#4329](https://github.com/truecharts/charts/issues/4329)) - - - ## [immich-1.0.6](https://github.com/truecharts/charts/compare/immich-1.0.5...immich-1.0.6) (2022-11-06) ### Chore @@ -112,9 +92,6 @@ - Auto-update chart README [skip ci] - update helm general non-major ([#4317](https://github.com/truecharts/charts/issues/4317)) - - - ## [immich-1.0.5](https://github.com/truecharts/charts/compare/immich-1.0.4...immich-1.0.5) (2022-11-05) ### Chore @@ -122,9 +99,6 @@ - Auto-update chart README [skip ci] - update helm general non-major ([#4308](https://github.com/truecharts/charts/issues/4308)) - - - ## [immich-1.0.4](https://github.com/truecharts/charts/compare/immich-1.0.3...immich-1.0.4) (2022-11-02) ### Chore @@ -132,9 +106,6 @@ - Auto-update chart README [skip ci] - update helm general non-major ([#4261](https://github.com/truecharts/charts/issues/4261)) - - - ## [immich-1.0.3](https://github.com/truecharts/charts/compare/immich-1.0.2...immich-1.0.3) (2022-10-25) ### Chore @@ -142,9 +113,6 @@ - Auto-update chart README [skip ci] - update helm general non-major - - - ## [immich-1.0.2](https://github.com/truecharts/charts/compare/immich-1.0.1...immich-1.0.2) (2022-10-25) ### Chore @@ -152,9 +120,6 @@ - Auto-update chart README [skip ci] - update helm general non-major ([#4182](https://github.com/truecharts/charts/issues/4182)) - - - ## [immich-1.0.1](https://github.com/truecharts/charts/compare/immich-1.0.0...immich-1.0.1) (2022-10-19) ### Chore @@ -163,18 +128,12 @@ - update helm general non-major ([#4122](https://github.com/truecharts/charts/issues/4122)) - allow to disable machine-learning container ([#4132](https://github.com/truecharts/charts/issues/4132)) - - - ## [immich-1.0.0](https://github.com/truecharts/charts/compare/immich-0.0.6...immich-1.0.0) (2022-10-14) ### Feat - Move to Stable ([#4094](https://github.com/truecharts/charts/issues/4094)) - - - ## [immich-0.0.6](https://github.com/truecharts/charts/compare/immich-0.0.5...immich-0.0.6) (2022-10-12) ### Chore @@ -182,9 +141,6 @@ - Auto-update chart README [skip ci] - update helm general non-major ([#4071](https://github.com/truecharts/charts/issues/4071)) - - - ## [immich-0.0.5](https://github.com/truecharts/charts/compare/immich-0.0.4...immich-0.0.5) (2022-10-07) ### Chore @@ -193,9 +149,6 @@ - Auto-update chart README [skip ci] - update helm general non-major - - - ## [immich-0.0.5](https://github.com/truecharts/charts/compare/immich-0.0.4...immich-0.0.5) (2022-10-07) ### Chore @@ -203,9 +156,6 @@ - Auto-update chart README [skip ci] - update helm general non-major - - - ## [immich-0.0.4](https://github.com/truecharts/charts/compare/immich-0.0.3...immich-0.0.4) (2022-10-05) ### Chore @@ -213,14 +163,12 @@ - Auto-update chart README [skip ci] - update helm general non-major - - - ## [immich-0.0.3](https://github.com/truecharts/charts/compare/immich-0.0.2...immich-0.0.3) (2022-10-03) ### Chore - Auto-update chart README [skip ci] + - split addons in smaller templates ([#3979](https://github.com/truecharts/charts/issues/3979)) - move to stable ([#3978](https://github.com/truecharts/charts/issues/3978)) @@ -228,9 +176,6 @@ - actually spin up microservices contaienr ([#3998](https://github.com/truecharts/charts/issues/3998)) - - - ## [immich-0.0.2](https://github.com/truecharts/charts/compare/immich-0.0.1...immich-0.0.2) (2022-09-29) ### Chore @@ -241,9 +186,6 @@ - add hostAliases due to upstream hardcoded urls ([#3956](https://github.com/truecharts/charts/issues/3956)) - - - ## [immich-0.0.1]immich-0.0.1 (2022-09-28) ### Feat diff --git a/charts/stable/immich/docs/install_notes.md b/charts/stable/immich/docs/install_notes.md index e52d282a4fa..8dcebf4e227 100644 --- a/charts/stable/immich/docs/install_notes.md +++ b/charts/stable/immich/docs/install_notes.md @@ -1,4 +1,6 @@ -# Install Notes +--- +title: Install Notes +--- ## Warning diff --git a/charts/stable/maintainerr/CHANGELOG.md b/charts/stable/maintainerr/CHANGELOG.md index 825c32f0d03..6afbcc5f802 100644 --- a/charts/stable/maintainerr/CHANGELOG.md +++ b/charts/stable/maintainerr/CHANGELOG.md @@ -1 +1,3 @@ -# Changelog +--- +title: Changelog +--- diff --git a/charts/stable/nvidia-gpu-exporter/CHANGELOG.md b/charts/stable/nvidia-gpu-exporter/CHANGELOG.md index 825c32f0d03..6afbcc5f802 100644 --- a/charts/stable/nvidia-gpu-exporter/CHANGELOG.md +++ b/charts/stable/nvidia-gpu-exporter/CHANGELOG.md @@ -1 +1,3 @@ -# Changelog +--- +title: Changelog +--- diff --git a/charts/stable/ollama/CHANGELOG.md b/charts/stable/ollama/CHANGELOG.md index 825c32f0d03..6afbcc5f802 100644 --- a/charts/stable/ollama/CHANGELOG.md +++ b/charts/stable/ollama/CHANGELOG.md @@ -1 +1,3 @@ -# Changelog +--- +title: Changelog +--- diff --git a/charts/stable/palworld/CHANGELOG.md b/charts/stable/palworld/CHANGELOG.md index 825c32f0d03..6afbcc5f802 100644 --- a/charts/stable/palworld/CHANGELOG.md +++ b/charts/stable/palworld/CHANGELOG.md @@ -1 +1,3 @@ -# Changelog +--- +title: Changelog +--- diff --git a/charts/stable/peanut/docs/installation-notes.md b/charts/stable/peanut/docs/installation-notes.md index 1810a821251..da275c9ef20 100644 --- a/charts/stable/peanut/docs/installation-notes.md +++ b/charts/stable/peanut/docs/installation-notes.md @@ -1,4 +1,6 @@ -# Installation Notes +--- +title: Installation Notes +--- Notes about the proper setup of PeaNUT. diff --git a/charts/stable/sftpgo/docs/plugins.md b/charts/stable/sftpgo/docs/plugins.md index 61b6fc47c56..94a46d23309 100644 --- a/charts/stable/sftpgo/docs/plugins.md +++ b/charts/stable/sftpgo/docs/plugins.md @@ -1,4 +1,6 @@ -# SFTPGo Plugins +--- +title: SFTPGo Plugins +--- Due to a number of different possible combinations of plugins, final configuration must be done through manually set environmental variables. Please refer to examples below. diff --git a/charts/stable/timetagger/docs/Install.md b/charts/stable/timetagger/docs/Install.md index 8e3fdd02ebf..88c5a81cf13 100644 --- a/charts/stable/timetagger/docs/Install.md +++ b/charts/stable/timetagger/docs/Install.md @@ -1,4 +1,6 @@ -# Credential Generation Basic Auth +--- +title: Credential Generation Basic Auth +--- To Setup Credentials for Basic Authg proceed to and enter the user name and password you wish to use diff --git a/charts/stable/truenas-exporter/docs/setup.md b/charts/stable/truenas-exporter/docs/setup.md index bfaeb06da82..781db17f74b 100644 --- a/charts/stable/truenas-exporter/docs/setup.md +++ b/charts/stable/truenas-exporter/docs/setup.md @@ -1,4 +1,6 @@ -# Connecting TrueNAS SCALE +--- +title: Connecting TrueNAS SCALE +--- TrueNAS Scale Inside of TrueNAS you have to open the `Reporting` tab and then click the `Exporters` button to adjust the already present graphite exporter by hitting the edit icon. diff --git a/charts/system/kubeapps/docs/token.md b/charts/system/kubeapps/docs/token.md index b6e721cea65..d7d02f2cb0a 100644 --- a/charts/system/kubeapps/docs/token.md +++ b/charts/system/kubeapps/docs/token.md @@ -2,6 +2,4 @@ title: Getting a Login Token for KubeApps --- -# Getting a Login Token - Currently KubeApps, by default, requires a kubernetes token to login. To acquire a temporary(!) token, enter the command given in the "notes" section (bottom right corner in SCALE WebUI) and copy the token given to the WebGUI of KubeApps. diff --git a/charts/system/nvidia-device-plugin/docs/installation.md b/charts/system/nvidia-device-plugin/docs/installation.md index aac3b97dc00..63335d74c0b 100644 --- a/charts/system/nvidia-device-plugin/docs/installation.md +++ b/charts/system/nvidia-device-plugin/docs/installation.md @@ -2,7 +2,7 @@ title: Nvidia Device Plugin Setup --- -# Talos Linux Setup +## Talos Linux Setup ## Enable NVIDIA kernel modules