banzaicloud / istio-operator

An operator that manages Istio deployments on Kubernetes
Apache License 2.0
535 stars 94 forks source link

Fix source fields in Chart.yaml files #901

Open john-a-joyce opened 1 year ago

john-a-joyce commented 1 year ago

Describe the bug Minor detail - but many of the "Source fields" in the Chart.yaml files point to istio upstream repos. Mostly we want to point to the banzai istio operator or maybe the eti/istio code. This this is an optional field and 2nd order documentation its pretty minor priority.

Steps to reproduce the issue: NA

Expected behavior NA

Screenshots If applicable, add screenshots to help explain your problem.

Additional context Add any other context about the problem like release number version, branch, etc.

Laci21 commented 1 year ago

Hi John,

Could you please paste a link to those fields that you mean? Also, why exactly is this an issue?

john-a-joyce commented 1 year ago

Let me be clear that this is not an issue that would affect anyone trying to use the operator. Its more of a perception thing so really minor. Here is a link to a line https://github.com/banzaicloud/istio-operator/blob/c9373e0b7a647f0347b3bd12c3b43897de556939/internal/assets/manifests/istio-discovery/Chart.yaml#L11 so that field in a Chart.yaml is to provide anyone using the chart where the source code for where the chart resides. AFAIK. Most of our sources point to the upstream Istio, but properly the source for these charts is banzaicloud/istio-operator. Again pretty minor. Rarely - maybe never would someone really use this field and get confused. I happened to notice it so I thought I would record it. It is fine if you want to close it with no change. It is easy to fix though.

Laci21 commented 1 year ago

I see now. These are internal charts though and not supposed to be used from the outside as helm charts, so I don't see much upside of the change. Feel free to a create a PR though and we can merge it or we can close this issue, both are fine to me.