Improvement for k8s.io/docs/concepts/overview/working-with-objects/common-labels/

[peterwwillis]

There is a suggested annotation of:

    app.kubernetes.io/managed-by: helm

But Helm actually recommends:

    app.kubernetes.io/managed-by: {{ .Release.Service }}

Which will insert a value of "Helm", with a first character in uppercase.

According to this research, labels are case-sensitive, except for the prefix.

(You can notice this discrepancy if you are using the helm diff plug-in, as your chart with a lower-case word will always be replaced with upper-case, so a three-way-merge diff shows this as changing every time. I also imagine you could find this if you tried to use the label as a selector)

Therefore I recommend that the suggested annotation in this document be replaced with:

    app.kubernetes.io/managed-by: Helm

Caveat: I have no idea if the case changed between helm v2 and v3, but v2 is defunct now, so should be safe to make this change.

[shannonxtreme]

This is just an example of what could go in, but I think it might be a good first issue.

If you want to work on this, assign yourself to this issue. Update all instances of app.kubernetes.io/managed-by: helm to Helm, including in the table.

You should be able to complete this in GitHub without needing to work on a local clone. For instructions, read Opening a pull request.

[steve-hardman]

/language en

[steve-hardman]

Let me help with this.

/assign

[shannonxtreme]

/triage accepted
/good-first-issue

[k8s-ci-robot]

@shannonxtreme:
This request has been marked as suitable for new contributors.

Guidelines

Please ensure that the issue body includes answers to the following questions:

• Why are we solving this issue?
• To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
• Does this issue have zero to low barrier of entry?
• How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

/triage accepted
/good-first-issue

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.