Skip to content
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

docs: fix link to update collector #1682

Merged
merged 1 commit into from
Oct 10, 2024

Conversation

ehrenfeu
Copy link
Contributor

Probably the collector got renamed from updates to update at some point but the link in the README was forgotten.

Probably the collector got renamed from `updates` to `update`
at some point but the link in the README was forgotten.

Signed-off-by: Niko Ehrenfeuchter <[email protected]>
@ehrenfeu ehrenfeu requested a review from a team as a code owner October 10, 2024 12:23
@jkroepke
Copy link
Member

Thanks!

@jkroepke jkroepke changed the title Fix link to update collector docs: fix link to update collector Oct 10, 2024
@jkroepke jkroepke changed the title docs: fix link to update collector chore(docs): fix link to update collector Oct 10, 2024
@jkroepke jkroepke merged commit 90ac0b2 into prometheus-community:master Oct 10, 2024
4 of 7 checks passed
@ehrenfeu
Copy link
Contributor Author

Thanks for merging @jkroepke ! 💚

Since I'm reading this this in the title now, I'd like to ask one thing that confuses me since a while when looking at e.g. the changelogs of a new release: what does chore mean? I was searching for a component of that name but couldn't find any...
Should it actually just read core instead, or is this a misinterpretation / lack of understanding on my side?

@jkroepke
Copy link
Member

jkroepke commented Oct 10, 2024

Glad you ask, I havn't that style documented here.

The base for that kind of term are conventional commits. I used this for all changes not related specific code package.

chore: Changes which doesn't change source code or tests e.g. changes to the build process, auxiliary tools, libraries

long: https://www.conventionalcommits.org/en/v1.0.0/
short: https://gist.github.com/Zekfad/f51cb06ac76e2457f11c80ed705c95a3

I used the style for PR titles, because PR title are used for changelog generation. But if someone add an fix for the update collector, update: may used here.

In this case, docs: would be the correct prefix, but my hand-written Ci check doesn't support docs: right now.

@jkroepke jkroepke changed the title chore(docs): fix link to update collector docs: fix link to update collector Oct 10, 2024
@ehrenfeu ehrenfeu deleted the patch-1 branch October 15, 2024 08:22
@ehrenfeu
Copy link
Contributor Author

Thanks for the detailed explanation 💡 and sorry for being unable to find this out myself 🤦🏼
Have to improve my googling 🔎 and obviously my English 🇬🇧 skills...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants