janus-idp / helm-backstage

Helm Chart for Deploying Backstage. This repo is deprecated. Please move to https://github.com/redhat-developer/rhdh-chart
https://redhat-developer.github.io/rhdh-chart/
Apache License 2.0
62 stars 54 forks source link

fix README file by providing correct instruction #74

Closed josephca closed 1 year ago

josephca commented 1 year ago

Minor bugs need to be fixed in readme,

tumido commented 1 year ago

Hi @josephca, thanks for raising this issue.

  1. Yes, the release name should be updated in the README, I'll update it. Thank you! 🙂
  2. The HELM_EXPERIMANTAL_OCI flag is deprecated since Helm v3.8.0 which was released in January of 2022. That is a year and a half ago. (See: https://helm.sh/docs/topics/registries/, https://github.com/helm/helm/releases/tag/v3.8.0). I don't think we should advise users on this since we don't aim to support every Helm version, so this should be safe to omit from the README.
josephca commented 1 year ago

@tumido I found one more place which may require a fix. From https://github.com/janus-idp/helm-backstage/blob/main/charts/backstage/README.md, at the end of the readme

upstream: backstage: -> it's missing appConfig: app:

tumido commented 1 year ago

I've updated the PR. Thank you for noticing 👍 🙂