Skip to content

Commit

Permalink
add metadata-enabled issue template (#10127)
Browse files Browse the repository at this point in the history
  • Loading branch information
gewarren authored Jul 19, 2024
1 parent d235ba9 commit b4c8e3c
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 1 deletion.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/01-general-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: "General feedback"
description: Provide general feedback about the .NET API reference docs or a specific article.
body:
- type: markdown
attributes:
value: Thanks for helping us improve the docs!
- type: textarea
id: description
attributes:
label: Describe the issue or suggestion
description: "Note: If your issue is about a specific article, it's best to submit your feedback by clicking the 'Open a documentation issue' link in the '.NET feedback' box at the end of the article."
validations:
required: true
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/z-customer-feedback.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Learn feedback control.
description: |
⛔ This template is hooked into the feedback control on the bottom of every page on the live site. It automatically fills in several fields for you. Don't use for other purposes. ⛔
body:
- type: markdown
attributes:
value: "## Issue information"
- type: markdown
attributes:
value: Select the issue type, and describe the issue in the text box below. Add as much detail as needed to help us resolve the issue.
- type: dropdown
id: issue-type
attributes:
label: Type of issue
options:
- Typo
- Code doesn't work
- Missing information
- Outdated article
- Thank you
- Other (describe below)
validations:
required: true
- type: textarea
id: feedback
validations:
required: true
attributes:
label: Description
- type: markdown
attributes:
value: "## 🚧 Article information 🚧"
- type: markdown
attributes:
value: "*Don't modify the following fields*. They are automatically filled in for you. Doing so will disconnect your issue from the affected article. *Don't edit them*."
- type: input
id: pageUrl
validations:
required: true
attributes:
label: Page URL
- type: input
id: contentSourceUrl
validations:
required: true
attributes:
label: Content source URL
- type: input
id: documentVersionIndependentId
validations:
required: true
attributes:
label: Document Version Independent Id
- type: input
id: author
validations:
required: true
attributes:
label: Article author
2 changes: 1 addition & 1 deletion docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"feedback_help_link_type": "get-help-at-qna",
"open_source_feedback_contributorGuideUrl": "https://learn.microsoft.com/contribute/content/dotnet/api-documentation",
"open_source_feedback_issueTitle": "",
"open_source_feedback_issueUrl": "https://github.com/dotnet/dotnet-api-docs/issues/new",
"open_source_feedback_issueUrl": "https://github.com/dotnet/dotnet-api-docs/issues/new?template=z-customer-feedback.yml",
"open_source_feedback_productLogoLightUrl": "https://learn.microsoft.com/media/logos/logo_net.svg",
"open_source_feedback_productLogoDarkUrl": "https://learn.microsoft.com/media/logos/logo_net.svg",
"open_source_feedback_productName": ".NET",
Expand Down

0 comments on commit b4c8e3c

Please sign in to comment.