Skip to content

Commit d3248cc

Browse files
authored
Add issue template for docs requests (#257)
Adds a general purpose issue template for docs requests. When someone creates an issue using the template, it presents an issue form. The form captures all information required for the issue to be ready for work by a tech writer. The template is copied and slightly modified from the [Obs docs repo](https://github.com/elastic/observability-docs/blob/main/.github/ISSUE_TEMPLATE/other-request.yaml).
1 parent a61ebbc commit d3248cc

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed
+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: "[Internal] Dcumentation request"
2+
description: Request a documentation change or enhancement for any supported release (Elastic employees).
3+
title: "[REQUEST]: "
4+
labels: ["request", "Team:Docs"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this request! This form will create an issue that the Platform Docs team will triage and prioritize.
10+
- type: textarea
11+
id: description
12+
attributes:
13+
label: Description
14+
description: Describe what needs to be documented.
15+
placeholder: I need...
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: related
20+
attributes:
21+
label: Resources
22+
description: Please link to as many related resources as possible. Think about issues, PRs, demos, Slack threads, existing or related docs pages, etc.
23+
placeholder: How can the docs team learn more about this feature?
24+
validations:
25+
required: true
26+
- type: dropdown
27+
id: collaboration
28+
attributes:
29+
label: Collaboration
30+
description: Choose the expected collaboration model
31+
options:
32+
- "Please choose a preferred collaboration model."
33+
- "The documentation team will investigate the issue and create the initial content."
34+
- "The product team will provide the initial content."
35+
- "TBD. The docs and product team will work together to determine the best path forward."
36+
- "Other (please describe below in the Point of contact section)."
37+
validations:
38+
required: true
39+
- type: textarea
40+
id: contact
41+
attributes:
42+
label: Point of contact.
43+
description: Please assign at least one point of contact using the GitHub `@` mention. Add as many stakeholders as you'd like.
44+
value: "**Main contact:** @\n\n**Stakeholders:**\n"
45+
validations:
46+
required: true

0 commit comments

Comments
 (0)