Skip to content

feat: add "Report an issue" button to docs pages#2906

Merged
juliusv merged 1 commit intoprometheus:mainfrom
jan--f:feat/report-issue-button
Mar 19, 2026
Merged

feat: add "Report an issue" button to docs pages#2906
juliusv merged 1 commit intoprometheus:mainfrom
jan--f:feat/report-issue-button

Conversation

@jan--f
Copy link
Contributor

@jan--f jan--f commented Mar 18, 2026

Adds a "Report an issue" button next to the existing "Edit this page" button on all documentation pages. The button opens a pre-filled GitHub issue in the same repo as the edit button (prometheus/docs for local docs, the upstream repo for repo-docs), with the page title and URL pre-populated.

Closes #378

@jan--f jan--f requested a review from juliusv March 18, 2026 19:13
@jan--f jan--f force-pushed the feat/report-issue-button branch from 125630b to 48cd83f Compare March 18, 2026 19:14
@jan--f
Copy link
Contributor Author

jan--f commented Mar 18, 2026

Hmm this doesn't look great.
2026-03-18-202321_791x345

Maybe better next to each other..

Adds a "Report an issue" button next to the existing "Edit this page"
button on all documentation pages. The button opens a pre-filled GitHub
issue in the same repo as the edit button (prometheus/docs for local
docs, the upstream repo for repo-docs), with the page title and URL
pre-populated.

Closes prometheus#378

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Jan Fajerski <jfajersk@redhat.com>
@jan--f jan--f force-pushed the feat/report-issue-button branch from 48cd83f to a0f8360 Compare March 18, 2026 19:25
@jan--f
Copy link
Contributor Author

jan--f commented Mar 18, 2026

2026-03-18-203400_765x217

This version looks better to me.

Copy link
Member

@bwplotka bwplotka left a comment

Choose a reason for hiding this comment

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

LGTM!

@juliusv , objections?

@juliusv
Copy link
Member

juliusv commented Mar 19, 2026

Looks good, thanks :)

@juliusv juliusv merged commit cd9936c into prometheus:main Mar 19, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make it easier to create issues for missing/confusing documentation

3 participants