Skip to content

Commit 7ae15df

Browse files
Add docs feedback issue template (#434)
Co-authored-by: Waldek Mastykarz <[email protected]>
1 parent e20f9d8 commit 7ae15df

File tree

1 file changed

+67
-0
lines changed

1 file changed

+67
-0
lines changed

.github/ISSUE_TEMPLATE/docs.yml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: Docs feedback
2+
description: >-
3+
⛔ This template is intended for use by the feedback control on the bottom of every page on the
4+
live site. If you aren't using the feedback control, choose one of the other templates.⛔
5+
title: "[FEEDBACK]: <short description>"
6+
labels: ["docs", "triage"]
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: Enter your feedback
11+
- type: markdown
12+
attributes:
13+
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.
14+
- type: dropdown
15+
id: issue-type
16+
attributes:
17+
label: Type of issue
18+
options:
19+
- Typo
20+
- Code doesn't work
21+
- Missing information
22+
- Outdated article
23+
- Other (describe below)
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: userfeedback
28+
validations:
29+
required: true
30+
attributes:
31+
label: Feedback
32+
description: >-
33+
If possible, please provide extended details that will add context and help the team update
34+
the documentation. Additional details may not be useful for typos, grammar, formatting, etc.
35+
For technical or factual errors, please include code snippets and output to show how the
36+
documentation is incorrect.
37+
- type: markdown
38+
attributes:
39+
value: Article information
40+
- type: markdown
41+
attributes:
42+
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*."
43+
- type: input
44+
id: pageUrl
45+
validations:
46+
required: true
47+
attributes:
48+
label: Page URL
49+
- type: input
50+
id: contentSourceUrl
51+
validations:
52+
required: true
53+
attributes:
54+
label: Content source URL
55+
- type: input
56+
id: author
57+
validations:
58+
required: true
59+
attributes:
60+
label: Author
61+
description: GitHub Id of the author
62+
- type: input
63+
id: documentVersionIndependentId
64+
validations:
65+
required: true
66+
attributes:
67+
label: Document Id

0 commit comments

Comments
 (0)