Skip to content

Commit 8f35441

Browse files
authored
Create community toolkit docs request issue template (#1995)
* Create community toolkit docs request issue template * Update 05-community-toolkit-docs-request.yml
1 parent 05d8a36 commit 8f35441

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: "Community Toolkit article request"
2+
description: Request a new article on a topic or concept related to the [Aspire Community Toolkit](https://github.com/CommunityToolkit/Aspire) that you can't find in our current docs.
3+
title: "[Community Toolkit New article]: "
4+
labels: ["doc-idea", "community-toolkit"]
5+
assignees: ["Alirexaa", "aaronpowell"]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: "## Request a new article"
10+
- type: markdown
11+
attributes:
12+
value: "Describe the proposed new article for us."
13+
- type: input
14+
id: topic
15+
attributes:
16+
label: Proposed topic or title
17+
description: Write a short title or description of the topic
18+
validations:
19+
required: true
20+
- type: markdown
21+
attributes:
22+
value: >
23+
"Propose a location for the article. Use the `/` character to
24+
define 'sub-folders' in the table of contents. Start with a top-level
25+
guide, and follow through to the parent folder for the new article."
26+
- type: markdown
27+
attributes:
28+
value: >
29+
"Explain why the article is needed. What will readers learn? Why is
30+
it important? What are the consequences if readers don't learn the topic?"
31+
- type: textarea
32+
id: motivation
33+
attributes:
34+
label: Reason for the article
35+
description: Tell us why this article is needed.
36+
validations:
37+
required: true
38+
- type: markdown
39+
attributes:
40+
value: >
41+
"Write an opening paragraph or abstract to explain what readers
42+
will learn from reading this article."
43+
- type: textarea
44+
id: abstract
45+
attributes:
46+
label: Article abstract
47+
description: Write a *brief* abstract for the article.
48+
validations:
49+
required: true
50+
- type: markdown
51+
attributes:
52+
value: >
53+
"Tell us about searches you did looking for this information. This helps us
54+
in two important ways. First, if the information exists, we can improve
55+
the findability of the article for those search ideas. If the article
56+
doesn't exist, this will help us make sure readers find it once it's written."
57+
- type: textarea
58+
id: searches
59+
attributes:
60+
label: Relevant searches
61+
description: >
62+
What search terms did you use to look for this information?
63+
validations:
64+
required: false

0 commit comments

Comments
 (0)