Skip to content

Fix sample-config YAML quoting and refresh documentation#714

Open
saripurigopi wants to merge 1 commit into
kubernetes-sigs:masterfrom
saripurigopi:fix-docs-and-sample-config
Open

Fix sample-config YAML quoting and refresh documentation#714
saripurigopi wants to merge 1 commit into
kubernetes-sigs:masterfrom
saripurigopi:fix-docs-and-sample-config

Conversation

@saripurigopi

@saripurigopi saripurigopi commented Jun 22, 2026

Copy link
Copy Markdown

What this PR does / why we need it

Fixes YAML parse errors in docs/sample-config.yaml caused by double-quoted
metricsQuery values containing inner double quotes (fixes #697).

Updates configuration documentation for accuracy and clarity (fixes #679):

  • Add YAML quoting guidance and link to working sample config
  • Fix incorrect metric names in config-walkthrough discovery example
  • Update walkthrough Kubernetes version references

Which issue(s) this PR fixes

Fixes #697
Fixes #679

Special notes for your reviewer

Documentation-only change. Verified docs/sample-config.yaml parses with PyYAML.

NONE

@kubernetes-prow kubernetes-prow Bot added do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jun 22, 2026
@kubernetes-prow

Copy link
Copy Markdown

This issue is currently awaiting triage.

If prometheus-adapter contributors determine this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Details

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-sigs/prow repository.

@kubernetes-prow

Copy link
Copy Markdown

Welcome @saripurigopi!

It looks like this is your first PR to kubernetes-sigs/prometheus-adapter 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/prometheus-adapter has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@kubernetes-prow kubernetes-prow Bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jun 22, 2026
@kubernetes-prow

Copy link
Copy Markdown

Hi @saripurigopi. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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-sigs/prow repository.

@kubernetes-prow

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: saripurigopi
Once this PR has been reviewed and has the lgtm label, please assign dgrisonnet for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubernetes-prow kubernetes-prow Bot requested review from dashpole and dgrisonnet June 22, 2026 21:00
@kubernetes-prow kubernetes-prow Bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jun 22, 2026
Fix double-quoted metricsQuery values in sample-config.yaml and config.md
that caused YAML parse errors.

Update config-walkthrough and walkthrough docs for accuracy.
@saripurigopi saripurigopi force-pushed the fix-docs-and-sample-config branch from 9fe3bc1 to d36abfd Compare June 22, 2026 21:01
@kubernetes-prow kubernetes-prow Bot removed the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Jun 22, 2026
@k8s-triage-robot

Copy link
Copy Markdown

Unknown CLA label state. Rechecking for CLA labels.

Send feedback to sig-contributor-experience at kubernetes/community.

/check-cla
/easycla

@kubernetes-prow kubernetes-prow Bot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jun 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation Out of Date Quoting issues in example config YAML

2 participants