diff --git a/.github/ISSUE_TEMPLATE/01-general-issue.yml b/.github/ISSUE_TEMPLATE/01-general-issue.yml new file mode 100644 index 00000000000..8091d406d07 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-general-issue.yml @@ -0,0 +1,13 @@ +name: "General feedback" +description: Provide general feedback about the .NET API reference 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 feedback' box at the end of the article." + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/z-customer-feedback.yml b/.github/ISSUE_TEMPLATE/z-customer-feedback.yml new file mode 100644 index 00000000000..b175c1ca902 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/z-customer-feedback.yml @@ -0,0 +1,59 @@ +name: Learn feedback control. +description: | + ⛔ This template is hooked into the feedback control on the bottom of every page on the live site. It automatically fills in several fields for you. Don't use for other purposes. ⛔ +body: + - type: markdown + attributes: + value: "## Issue information" + - type: markdown + attributes: + value: Select the issue type, and describe the issue in the text box below. Add as much detail as needed to help us resolve the issue. + - type: dropdown + id: issue-type + attributes: + label: Type of issue + options: + - Typo + - Code doesn't work + - Missing information + - Outdated article + - Thank you + - Other (describe below) + validations: + required: true + - type: textarea + id: feedback + validations: + required: true + attributes: + label: Description + - type: markdown + attributes: + value: "## 🚧 Article information 🚧" + - type: markdown + attributes: + value: "*Don't modify the following fields*. They are automatically filled in for you. Doing so will disconnect your issue from the affected article. *Don't edit them*." + - type: input + id: pageUrl + validations: + required: true + attributes: + label: Page URL + - type: input + id: contentSourceUrl + validations: + required: true + attributes: + label: Content source URL + - type: input + id: documentVersionIndependentId + validations: + required: true + attributes: + label: Document Version Independent Id + - type: input + id: author + validations: + required: true + attributes: + label: Article author diff --git a/docfx.json b/docfx.json index 8623875a78e..e2c052892f2 100644 --- a/docfx.json +++ b/docfx.json @@ -58,7 +58,7 @@ "feedback_help_link_type": "get-help-at-qna", "open_source_feedback_contributorGuideUrl": "https://learn.microsoft.com/contribute/content/dotnet/api-documentation", "open_source_feedback_issueTitle": "", - "open_source_feedback_issueUrl": "https://github.com/dotnet/dotnet-api-docs/issues/new", + "open_source_feedback_issueUrl": "https://github.com/dotnet/dotnet-api-docs/issues/new?template=z-customer-feedback.yml", "open_source_feedback_productLogoLightUrl": "https://learn.microsoft.com/media/logos/logo_net.svg", "open_source_feedback_productLogoDarkUrl": "https://learn.microsoft.com/media/logos/logo_net.svg", "open_source_feedback_productName": ".NET",