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

feat(docs): add feedback button #2145

Merged
merged 3 commits into from
Feb 7, 2025

Conversation

erinecon
Copy link
Contributor

@erinecon erinecon commented Feb 5, 2025

Add a "Give feedback" button to the top of the RTD site that links the user to a GitHub issue form to describe any feedback they have about a particular docs page.

@erinecon erinecon marked this pull request as ready for review February 6, 2025 17:24
@medubelko medubelko force-pushed the craft-4114-add-feedback-button branch 2 times, most recently from 6e75f7c to 6f54b28 Compare February 6, 2025 20:45
Copy link
Contributor

@medubelko medubelko left a comment

Choose a reason for hiding this comment

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

LGTM!

Longer-term we'll replace the composed text in the query with a simple link to a GitHub issue template (CRAFT-4123).

@medubelko medubelko force-pushed the craft-4114-add-feedback-button branch from 6f54b28 to 1ab7b2c Compare February 7, 2025 00:24
@medubelko
Copy link
Contributor

Simplified the change because we only need to enable the button, not re-implement it.

@medubelko
Copy link
Contributor

Refactored: 6bacc57

@medubelko medubelko changed the title Feat: add feedback button to the RTD site feat(docs): add feedback button Feb 7, 2025
Copy link
Collaborator

@lengau lengau left a comment

Choose a reason for hiding this comment

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

LGTM.

Is there any way to make this automatically label the issue with "Documentation"?

@medubelko
Copy link
Contributor

Is there any way to make this automatically label the issue with "Documentation"?

The template is hard-coded with the extension, unfortunately, and if we're to customise it I'd rather create a pull request template and use that instead (CRAFT-4123).

@lengau lengau enabled auto-merge February 7, 2025 20:54
@lengau lengau added this pull request to the merge queue Feb 7, 2025
Merged via the queue into canonical:main with commit 86e6402 Feb 7, 2025
30 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.

3 participants