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

Correcting the documentation for xxxmonitornamespaceselector in prometheus crd #6550

Closed
fettimbapro opened this issue Apr 26, 2024 · 3 comments

Comments

@fettimbapro
Copy link

fettimbapro commented Apr 26, 2024

Component(s)

No response

What is missing? Please describe.

Greetings promethesians!
I am a long time enjoyer of prometheus-operator, you guys are killing it!

I have a small note on the wording of the api.md documentation, while trying to edit the podmonitornamespaceselector-field, I tried to follow the documentation of using a "null value" in multiple different syntaxes, alas I finally got it to work by simply removing the line of code from the yaml manifest.

I propose a change in the description of all xxxmonitornamespaceselectors

from:

Namespaces to match for xxxMonitors discovery. An empty label selector
matches all namespaces. A null label selector matches the current
namespace only.

to:

Namespaces to match for xxxMonitors discovery. An empty label selector
matches all namespaces. A null label selector (default value) matches the current
namespace only.

This would clarify how an administer of prometheus would go about doing stuff.

Hope you have a great weekend!
Best regards,
Sam

Describe alternatives you've considered.

No response

Environment Information.

Environment

Kubernetes Version:
Prometheus-Operator Version:

@fettimbapro fettimbapro added kind/feature needs-triage Issues that haven't been triaged yet labels Apr 26, 2024
@simonpasquier simonpasquier added help wanted kind/documentation and removed kind/feature needs-triage Issues that haven't been triaged yet labels Apr 29, 2024
@simonpasquier
Copy link
Contributor

thanks for the kind words! Do you want to contribute the change?

@AshwinSriram11
Copy link
Contributor

I can work on this issue @simonpasquier. Also, is there any other changes needed in the description other than the one mentioned by @fettimbapro ?

@ArthurSens
Copy link
Member

Fixed by #6605

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

No branches or pull requests

4 participants