Skip to content

Commit

Permalink
Clean up issue templates (#516)
Browse files Browse the repository at this point in the history
  • Loading branch information
IEvangelist authored Mar 14, 2024
1 parent 598d9b1 commit 95eacd9
Show file tree
Hide file tree
Showing 6 changed files with 83 additions and 102 deletions.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/01-general-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: "General feedback"
description: Provide general feedback about the .NET Aspire docs or a specific article.
body:
- type: markdown
attributes:
value: Thanks for helping us improve the docs!
- type: textarea
id: description
attributes:
label: Describe the issue or suggestion
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 Aspire feedback' box at the end of the article."
validations:
required: true
70 changes: 70 additions & 0 deletions .github/ISSUE_TEMPLATE/02-docs-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: "New article request"
description: Request a new article on a topic or concept that you can't find in our current docs.
title: "[New article]: "
labels: ["doc-idea"]
body:
- type: markdown
attributes:
value: "## Request a new article"
- type: markdown
attributes:
value: "Describe the proposed new article for us."
- type: input
id: topic
attributes:
label: Proposed topic or title
description: Write a short title or description of the topic
validations:
required: true
- type: markdown
attributes:
value: >
"Propose a location for the article. Use the `/` character to
define 'sub-folders' in the table of contents. Start with a top-level
guide, and follow through to the parent folder for the new article."
- type: input
id: toc-item
attributes:
label: Location in table of contents.
description: Give some indication for the location in the table of contents.
validations:
required: false
- type: markdown
attributes:
value: >
"Explain why the article is needed. What will readers learn? Why is
it important? What are the consequences if readers don't learn the topic?"
- type: textarea
id: motivation
attributes:
label: Reason for the article
description: Tell us why this article is needed.
validations:
required: true
- type: markdown
attributes:
value: >
"Write an opening paragraph or abstract to explain what readers
will learn from reading this article."
- type: textarea
id: abstract
attributes:
label: Article abstract
description: Write a *brief* abstract for the article.
validations:
required: true
- type: markdown
attributes:
value: >
"Tell us about searches you did looking for this information. This helps us
in two important ways. First, if the information exists, we can improve
the findability of the article for those search ideas. If the article
doesn't exist, this will help us make sure readers find it once it's written."
- type: textarea
id: searches
attributes:
label: Relevant searches
description: >
What search terms did you use to look for this information?
validations:
required: false
43 changes: 0 additions & 43 deletions .github/ISSUE_TEMPLATE/doc-issue.md

This file was deleted.

23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/docs-request.md

This file was deleted.

36 changes: 0 additions & 36 deletions .github/ISSUE_TEMPLATE/okr-internal-use-only-template.md

This file was deleted.

0 comments on commit 95eacd9

Please sign in to comment.