From 6e42231c9ed512784287d7ebdc88e4264d52dcfb Mon Sep 17 00:00:00 2001 From: gismo2004 <2325636+gismo2004@users.noreply.github.com> Date: Thu, 20 Feb 2025 19:02:02 +0100 Subject: [PATCH] docs(immich) reduce to warning (#32296) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description** retain Immich warning, clean up extra text ⚒️ 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 - [x] 📜 Documentation Changes **🧪 How Has This Been Tested?** **📃 Notes:** **✔️ 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 - [ ] 📄 I have made changes to the documentation - [ ] 🧪 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):`, `chore(chart-name):`, `docs(chart-name):` or `fix(docs):` **➕ 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._ --------- Signed-off-by: Alfred Göppel <43101280+alfi0812@users.noreply.github.com> Co-authored-by: Alfred Göppel <43101280+alfi0812@users.noreply.github.com> --- charts/stable/immich/docs/install_notes.md | 22 +++------------------- 1 file changed, 3 insertions(+), 19 deletions(-) diff --git a/charts/stable/immich/docs/install_notes.md b/charts/stable/immich/docs/install_notes.md index 4d7fad23912..1ba11e398ac 100644 --- a/charts/stable/immich/docs/install_notes.md +++ b/charts/stable/immich/docs/install_notes.md @@ -4,25 +4,9 @@ title: Install Notes ## Warning -Immich is essentially pre-alpha, it works but its releases are extremely unrelyable while not complying to semver at all. -This means that Immich might randomly and unexpectedly stop working or loose data. +Immich is still in a pre-alpha stage - it works, but its releases are highly unreliable and do not adhere to semantic versioning (SemVer). This means that Immich may unexpectedly break or even result in data loss. -That goes for every way you deploy it: There be dragons. -You're warned. have fun! +This applies to all deployment methods - proceed with caution. -## +There be dragons. You've been warned. Have fun! -This chart now requires the following hcarts to be installed before you can install: - -- prometheus-operator -- cloudnative-pg - -These are in the system train. - -To enable this in TrueNAS scale - -- Apps -- Manage Catalogs. -- Edit the TrueCharts Catalog (under the three dots). -- Enable the system train under 'Perferred Trains'. -- Install the required charts in Available Applications