From 5ba92fe5db382fce58fe76cc5061bbcbfdda6379 Mon Sep 17 00:00:00 2001 From: Matt Wojciakowski Date: Fri, 2 Feb 2024 13:02:50 -0800 Subject: [PATCH] Update to new feedback mechanism (#1917) * Update to new feedback mechanism * fix desc syntax --- .github/ISSUE_TEMPLATE/doc-issue.yml | 63 ++++++++++++++++++++++++++++ WSL/docfx.json | 11 ++++- WSL/media/wsl-icon.svg | 32 ++++++++++++++ 3 files changed, 104 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/doc-issue.yml create mode 100644 WSL/media/wsl-icon.svg diff --git a/.github/ISSUE_TEMPLATE/doc-issue.yml b/.github/ISSUE_TEMPLATE/doc-issue.yml new file mode 100644 index 00000000..77a6b454 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/doc-issue.yml @@ -0,0 +1,63 @@ +name: Post a documentation issue +title: Contribute Feedback +description: >- + Post an issue specific to WSL documentation. +labels: + - "needs-triage" +body: + - type: markdown + attributes: + value: "## Enter your feedback" + - 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: userfeedback + validations: + required: true + attributes: + label: Feedback + description: Provide details that will add context on what should be updated in the documentation. Additional details not needed for typos, grammar, formatting, etc. For technical or factual errors, please include code snippets and output to show how the documentation is incorrect. + - 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: author + validations: + required: true + attributes: + label: Author + description: GitHub Id of the author + - type: input + id: documentVersionIndependentId + validations: + required: true + attributes: + label: Document Id \ No newline at end of file diff --git a/WSL/docfx.json b/WSL/docfx.json index 07d2d6f9..0be08fff 100644 --- a/WSL/docfx.json +++ b/WSL/docfx.json @@ -35,8 +35,15 @@ "breadcrumb_path": "/windows/wsl/breadcrumb/toc.json", "uhfHeaderId": "MSDocsHeader-Windows", "recommendations" : true, - "feedback_system": "GitHub", - "feedback_github_repo": "MicrosoftDocs/WSL", + "feedback_product_url": "https://github.com/Microsoft/wsl/issues", + "feedback_system": "OpenSource", + "open_source_feedback_contributorGuideUrl": "https://learn.microsoft.com/contribute/content/how-to-write-quick-edits", + "open_source_feedback_issueTitle": "", + "open_source_feedback_issueLabels": "needs-triage", + "open_source_feedback_issueUrl": "https://github.com/MicrosoftDocs/wsl/issues/new?template=doc-issues.yml", + "open_source_feedback_productLogoLightUrl": "https://learn.microsoft.com/windows/wsl/media/wsl-icon.svg", + "open_source_feedback_productLogoDarkUrl": "https://learn.microsoft.com/windows/wsl/media/wsl-icon.svg", + "open_source_feedback_productName": "Windows Subsystem for Linux", "ms.service": "dev-environment", "ms.subservice": "windows-subsystem-for-linux", "author": "craigloewen-msft", diff --git a/WSL/media/wsl-icon.svg b/WSL/media/wsl-icon.svg new file mode 100644 index 00000000..0e7c0d37 --- /dev/null +++ b/WSL/media/wsl-icon.svg @@ -0,0 +1,32 @@ + + + + + + + + + + +