diff --git a/.github/ISSUE_TEMPLATE/01-general-issue.yml b/.github/ISSUE_TEMPLATE/01-general-issue.yml new file mode 100644 index 0000000000..b3c14e482b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-general-issue.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/02-docs-request.yml b/.github/ISSUE_TEMPLATE/02-docs-request.yml new file mode 100644 index 0000000000..e5368d460e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-docs-request.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/doc-issue.md b/.github/ISSUE_TEMPLATE/doc-issue.md deleted file mode 100644 index 8560dd16f7..0000000000 --- a/.github/ISSUE_TEMPLATE/doc-issue.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -name: ".NET Aspire doc issue" -about: Report a problem in the .NET Aspire documentation -title: '' -labels: '' -assignees: '' ---- - - - -**Issue description** - - - -**Target framework** - - - -- [ ] .NET Core -- [ ] .NET Framework -- [ ] .NET Standard - - - -
-dotnet --info output or About VS info - -```console - -``` -
diff --git a/.github/ISSUE_TEMPLATE/docs-request.md b/.github/ISSUE_TEMPLATE/docs-request.md deleted file mode 100644 index e5fedde271..0000000000 --- a/.github/ISSUE_TEMPLATE/docs-request.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: ".NET Aspire doc request" -about: Request a new article to provide missing information -title: '' -labels: '' -assignees: '' ---- - -**Help us make content visible** - - - -**Describe the new article** - - diff --git a/.github/ISSUE_TEMPLATE/okr-internal-use-only-template.md b/.github/ISSUE_TEMPLATE/okr-internal-use-only-template.md deleted file mode 100644 index eaf5f68a7d..0000000000 --- a/.github/ISSUE_TEMPLATE/okr-internal-use-only-template.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -name: OKR internal use only template -about: This is the object key result (OKR) template, for internal use only. -title: 'OKR: address x, y, and z' -labels: OKR -assignees: '' ---- - - diff --git a/.github/ISSUE_TEMPLATE/customer-feedback.yml b/.github/ISSUE_TEMPLATE/z-customer-feedback.yml similarity index 100% rename from .github/ISSUE_TEMPLATE/customer-feedback.yml rename to .github/ISSUE_TEMPLATE/z-customer-feedback.yml