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

Add "Documentation issue" option #1823

Merged
merged 1 commit into from
Nov 3, 2023

Conversation

hamnarauf
Copy link
Contributor

@hamnarauf hamnarauf commented Nov 3, 2023

Summary of the pull request

Added a new option "Report a documentation issue" in Settings > Feedback section.

References and relevant issues

#1115
#1741 (review)

Detailed description of the pull request / Additional comments

Validation steps performed

image

image

When you enter the description in DevHome and preview it on GitHub, the issue's description field is currently not populated because its ID was missing from the Github issue template. I have now included the ID in the issue template. Once the PR is merged, the description field will be populated as expected.

PR checklist

Copy link
Collaborator

@krschau krschau left a comment

Choose a reason for hiding this comment

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

Thanks, looks great!

For anyone else who comes along and tries it and may want to say "but it doesn't fill in the description text on GitHub!" -- that's because the "description" id doesn't exist until this goes in. It took me a second to figure that out. 😄

@EricJohnson327 EricJohnson327 merged commit 22d55f2 into microsoft:main Nov 3, 2023
4 checks passed
@hamnarauf hamnarauf deleted the documentationBug branch November 3, 2023 18:35
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.

Extra feedback option
3 participants