search

immich-app / immich-charts

Helm chart implementation of Immich
https://immich.app
GNU Affero General Public License v3.0
107 stars 45 forks source link

docs: Update Installation guide of README.md #34

Closed choikangjae closed 8 months ago

choikangjae commented 1 year ago

Added some more detail version of Installation.

PixelJonas commented 1 year ago

This is a very opinionated way of installing the chart. While I like having a full guide that helps you people are using A LOT of different ways to install their charts into k8s. I don't know if a Guide on the README is the correct way.

I'd rather have it on an external site (maybe a blog-post from you @choikangjae ?) and link that post in the README like "if you need help installing a helm chart, take a look at the following resources ..."

@bo0tzz what do you think?

bo0tzz commented 1 year ago

I agree, I don't think we need to document how to install a helm chart, there's plenty of other places where that is described already ;) Maybe we can have an examples section where we link to blog posts and things like https://nanne.dev/k8s-at-home-search/hr/immich-app.github.io-immich-charts-immich#hr%20 ?

choikangjae commented 1 year ago

I agree I went down too much details. But it was quite hard to grasp what should I do with values.yaml. It could be easier if more comments are added on some important lines. Or maybe configuration table which holds all the detail, default and explanations?