Skip to content

Commit 9a08b6e

Browse files
cottibmorelli25
andauthored
Introduce an Issue Report template to be used by docsv3. (#886)
As a part of the changes required for elastic/docs-builder#748, this PR introduces a new template for issue reports to be consumed by a "`Report an issue`" link in the documentation. The `link` input will be populated by default with the page the user came from. --------- Co-authored-by: Brandon Morelli <[email protected]>
1 parent 1a71646 commit 9a08b6e

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed
+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: "Docs issue"
2+
description: Report documentation issues such as inaccuracies, broken links, typos, or missing information.
3+
title: "[Issue]: "
4+
labels: ["triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Hi 👋. Thanks for taking the time to fill out this issue report!
10+
This form will create an issue that Elastic's docs team will triage and prioritize.
11+
You can also open a PR instead.
12+
- type: dropdown
13+
attributes:
14+
label: Type of issue
15+
description: What type of issue are you reporting?
16+
multiple: false
17+
options:
18+
- Inaccurate
19+
- Missing information
20+
- I can't find what I'm looking for
21+
- Other
22+
- Other
23+
- type: input
24+
id: link
25+
attributes:
26+
label: What documentation page is affected
27+
description: Include a link to the page where you're seeing the problem.
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: related
32+
attributes:
33+
label: What happened?
34+
description: Describe the issue you're experiencing. Screenshots are valuable too!
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: moreinfo
39+
attributes:
40+
label: Additional info
41+
description: Anything else we should know?
42+
validations:
43+
required: false

0 commit comments

Comments
 (0)