Skip to content

[DO NOT MERGE] Test fixture: editorial issues for dashboard review composer - #38672

Open
buraizu wants to merge 3 commits into
masterfrom
bryce/oc-dashboard-test
Open

[DO NOT MERGE] Test fixture: editorial issues for dashboard review composer#38672
buraizu wants to merge 3 commits into
masterfrom
bryce/oc-dashboard-test

Conversation

@buraizu

@buraizu buraizu commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

[DO NOT MERGE] Test fixture for docs on-call dashboard

This PR exists only to exercise the docs team dashboard's PR review composer. It intentionally introduces editorial issues into a single FAQ page. Do not merge it. Close it once dashboard testing is finished.

What's here

Five deliberate edits to content/en/metrics/faq/updating-to-distribution-metrics-faq.md, chosen to produce a specific mix of review findings:

Three that should produce inline comments with direct replacement suggestions:

  1. Intro paragraph — utilize and in order to (word-list swaps).
  2. Nested list item — easily and leverage. This one is indented two spaces on purpose, to verify suggestion blocks preserve leading indentation.
  3. Manage Tags paragraph — first-person Our, allows you to, and a passive trailing clause.

Two that should produce general (review-body) comments:

  1. A new ## Percentile Configuration Best Practices section — heading breaks the file's question pattern and uses title case instead of sentence case; body is passive throughout and restates content from an earlier section.
  2. A bulleted list under the bulk-percentiles section — items are not parallel (imperative, declarative, and a bare noun phrase) with inconsistent capitalization and end punctuation.

No new technical claims are introduced; edits 4 and 5 restate behavior already documented on the page.

Ready for merge

  • Ready for merge

@buraizu
buraizu requested a review from a team as a code owner July 31, 2026 21:57
@github-actions github-actions Bot added the FAQ Content impacting a FAQ label Jul 31, 2026
@buraizu buraizu added Do Not Merge Just do not merge this PR :) WORK IN PROGRESS No review needed, it's a wip ;) labels Jul 31, 2026
@github-actions

github-actions Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

@buraizu buraizu self-assigned this Jul 31, 2026
Comment thread content/en/metrics/faq/updating-to-distribution-metrics-faq.md
Comment thread content/en/metrics/faq/updating-to-distribution-metrics-faq.md
Comment thread content/en/metrics/faq/updating-to-distribution-metrics-faq.md
Comment thread content/en/metrics/faq/updating-to-distribution-metrics-faq.md
Comment thread content/en/metrics/faq/updating-to-distribution-metrics-faq.md

@buraizu buraizu left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. New section restates existing content and breaks the page's heading pattern

Every other heading on this page is phrased as a question, matching the page's FAQ format; this new heading is a title-case noun phrase, breaking both the question pattern and the sentence-case rule for headings. Its content — that custom-metric counts for percentile-enabled distributions are counted like other metric types — already appears earlier on the page in the "How does this new pipeline for Distributions affect me?" section, and the body is written entirely in passive voice.

Suggested fix: Remove this section since it doesn't add new information beyond what's already stated earlier on the page. If it's kept, rephrase the heading as a question in sentence case and rewrite the body in active voice.


  1. Bulk-configure bullet list is not parallel

The four list items mix grammatical forms (a declarative statement, an imperative instruction, another declarative statement, and a bare noun phrase), and are inconsistent in capitalization and end punctuation — only one item is capitalized and only one ends with a period.

Suggested fix: Confirm that your wildcard pattern matches only the intended metric names.

  1. test

Comment thread content/en/metrics/faq/updating-to-distribution-metrics-faq.md
@github-actions github-actions Bot added the Images Images are added/removed with this PR label Aug 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Do Not Merge Just do not merge this PR :) FAQ Content impacting a FAQ Images Images are added/removed with this PR WORK IN PROGRESS No review needed, it's a wip ;)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant