helm-charts icon indicating copy to clipboard operation
helm-charts copied to clipboard

fix: prometheus docs mentioning master as config field that has been …

Open Hillkorn opened this issue 1 year ago • 3 comments

…renamed to controller

What does this PR do?

  • Fixes the documentation of the fields mentioned in the prometheus montitor

If you modified files in the ./charts/jenkins/ directory, please also include the following:

### Submitter checklist
- [ ] I bumped the "version" key in `./charts/jenkins/Chart.yaml`.
- [ ] I added a new changelog entry to `./charts/jenkins/CHANGELOG.md`.
- [ ] I followed the [technical requirements](https://github.com/jenkinsci/helm-charts/blob/main/CONTRIBUTING.md#technical-requirements).

Special notes for your reviewer

I think none of the above tasks is required by that config documentation change

Hillkorn avatar Dec 05 '23 14:12 Hillkorn

@Hillkorn Please take a look at the PR submitter checklist.

NotMyFault avatar Dec 13 '23 19:12 NotMyFault

@Hillkorn Please take a look at the PR submitter checklist.

Is it even required for such a documentation update? I guess it was missed during the renaming of the config field master -> controller . I used the wrong field name because of this and then looked it up in the helm templates to find out that the field name is different. The change is also in the changelog but the documentation still uses the old name.

Hillkorn avatar Jan 09 '24 15:01 Hillkorn

@Hillkorn Please take a look at the PR submitter checklist.

Is it even required for such a documentation update? I guess it was missed during the renaming of the config field master -> controller . I used the wrong field name because of this and then looked it up in the helm templates to find out that the field name is different. The change is also in the changelog but the documentation still uses the old name.

anything that changes something in the chart folder requires a bump currently.

timja avatar Jan 09 '24 15:01 timja