New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Proposal: Add url to chart maintainer details #3056
Comments
I could see the value in a URL field like "report-bugs-to". I've seen that format used in other places where the maintainers want to point users to file bug reports or further discussion over (as opposed to direct email), such as a mailing list or a forum. For example, PEP 1 describes the "Discussions-To" field in PEPs as
Would that help resolve the issue for monocular? |
Another valid use case: We (as the former Deis team) set up an engineering@deis.com email address for users to file bug reports with the charts to satisfy this field. However, we would prefer to point users over to https://github.com/deis/workflow/issues instead. Does that seem to satisfy the requirements? :) |
Just to add some context, the reason we point to a GitHub profile was to provide a better experience than a mailto link in the case of the stable/incubator repos. The Charts team decided on using GitHub IDs for maintainer names, but this is being implemented gradually and so we currently have some broken links. I do feel that a URL field will be useful and agree with @bacongobbler's usecases. +1 for adding url as an optional field to the maintainer object. |
Each maintainer can have an optional URL. There are seceral use cases for providing a URL instead of an email address: - The case where a maintainer wants to hide their email address behind a webform for personal security - When the maintainer is an organization and feedback should go to an issue queue This change: - Adds the proto field for url - Updates the generated files for the chart proto - Includes linting for the url - Updates the docs to include the url Closes helm#3056
There are times you want a URL to a package maintainer.
For example, in Monocular (as seen on Kubeapps.com) the name is taken and turned into a url to a location on GitHub (see issue about it as a bug). This doesn't work for a variety of reasons.
It would be nice to use a URL to a maintainers chosen location. This could even be used as an alternative to an email address for those who don't want to give it out. See the monocular issue for a couple example of hiding email addresses.
The proposal is to add a URL field alongside the email one...
https://github.com/kubernetes/helm/blob/3fc189d688fdfd4c0423fa6888a7762f8cde2381/_proto/hapi/chart/metadata.proto#L21-L28
The text was updated successfully, but these errors were encountered: