Skip to content

Commit b4c8e3c

Browse files
authored
add metadata-enabled issue template (#10127)
1 parent d235ba9 commit b4c8e3c

File tree

3 files changed

+73
-1
lines changed

3 files changed

+73
-1
lines changed
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: "General feedback"
2+
description: Provide general feedback about the .NET API reference docs or a specific article.
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: Thanks for helping us improve the docs!
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: Describe the issue or suggestion
11+
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."
12+
validations:
13+
required: true
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Learn feedback control.
2+
description: |
3+
⛔ 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. ⛔
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: "## Issue information"
8+
- type: markdown
9+
attributes:
10+
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.
11+
- type: dropdown
12+
id: issue-type
13+
attributes:
14+
label: Type of issue
15+
options:
16+
- Typo
17+
- Code doesn't work
18+
- Missing information
19+
- Outdated article
20+
- Thank you
21+
- Other (describe below)
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: feedback
26+
validations:
27+
required: true
28+
attributes:
29+
label: Description
30+
- type: markdown
31+
attributes:
32+
value: "## 🚧 Article information 🚧"
33+
- type: markdown
34+
attributes:
35+
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*."
36+
- type: input
37+
id: pageUrl
38+
validations:
39+
required: true
40+
attributes:
41+
label: Page URL
42+
- type: input
43+
id: contentSourceUrl
44+
validations:
45+
required: true
46+
attributes:
47+
label: Content source URL
48+
- type: input
49+
id: documentVersionIndependentId
50+
validations:
51+
required: true
52+
attributes:
53+
label: Document Version Independent Id
54+
- type: input
55+
id: author
56+
validations:
57+
required: true
58+
attributes:
59+
label: Article author

docfx.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
"feedback_help_link_type": "get-help-at-qna",
5959
"open_source_feedback_contributorGuideUrl": "https://learn.microsoft.com/contribute/content/dotnet/api-documentation",
6060
"open_source_feedback_issueTitle": "",
61-
"open_source_feedback_issueUrl": "https://github.com/dotnet/dotnet-api-docs/issues/new",
61+
"open_source_feedback_issueUrl": "https://github.com/dotnet/dotnet-api-docs/issues/new?template=z-customer-feedback.yml",
6262
"open_source_feedback_productLogoLightUrl": "https://learn.microsoft.com/media/logos/logo_net.svg",
6363
"open_source_feedback_productLogoDarkUrl": "https://learn.microsoft.com/media/logos/logo_net.svg",
6464
"open_source_feedback_productName": ".NET",

0 commit comments

Comments
 (0)