From 37bdfe323ed1f78406154d16c183428c4fbef7ed Mon Sep 17 00:00:00 2001 From: Bill Wagner Date: Fri, 22 Mar 2024 13:07:33 -0400 Subject: [PATCH] Create API docs feedback template (#72670) * Create API docs feedback template This adds the issue template that will be configured for roslyn-api-docs feedback published on docs.microsoft.com. Many of the fields will be applied from the query string of the referrer URL. * Update .github/ISSUE_TEMPLATE/z-apidocs-feedback.yml Co-authored-by: Fred Silberberg --------- Co-authored-by: Fred Silberberg --- .github/ISSUE_TEMPLATE/z-apidocs-feedback.yml | 46 +++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/z-apidocs-feedback.yml diff --git a/.github/ISSUE_TEMPLATE/z-apidocs-feedback.yml b/.github/ISSUE_TEMPLATE/z-apidocs-feedback.yml new file mode 100644 index 0000000000000..4ebe78e3dfa34 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/z-apidocs-feedback.yml @@ -0,0 +1,46 @@ +name: Learn feedback control. +description: | + ⛔ This template is hooked into the feedback control on Roslyn API documentation on docs.microsoft.com. 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 + - 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