From cd1356ed9b55a7a0b5751175e8862a20170cbd5b Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Wed, 13 Sep 2023 11:06:46 -0500 Subject: [PATCH 1/4] Add feedback template (#10414) * Add feedback template * Fix description --- .../ISSUE_TEMPLATE/04-customer-feedback.yml | 59 +++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/04-customer-feedback.yml diff --git a/.github/ISSUE_TEMPLATE/04-customer-feedback.yml b/.github/ISSUE_TEMPLATE/04-customer-feedback.yml new file mode 100644 index 000000000000..379510776ac3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04-customer-feedback.yml @@ -0,0 +1,59 @@ +name: Feedback from live site +title: "[Documentation feedback] - " +description: >- + This template is intended for use by the feedback control on the bottom of every page on the live + site. If you aren't using the feedback control, choose one of the other templates. +labels: + - "needs-triage" +body: + - 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: documentId + validations: + required: true + attributes: + label: Document Id + - type: textarea + id: summary + validations: + required: true + attributes: + label: Summary + description: | + Write a short description of the problem or feedback. + - type: textarea + id: details + validations: + required: false + attributes: + label: Details + description: >- + If possible, please provide extended details that will add context and help the team update + the documentation. Additional details may not be useful for typos, grammar, formatting, etc. + For technical or factual errors, please include code snippets and output to show how the + documentation is incorrect. + - type: textarea + id: environment + validations: + required: false + attributes: + label: Environment + description: >- + Run the following command and paste the results in the textbox below. + + ```powershell + $PSVersionTable + Get-Module + ``` + render: console From c068009eed5174b0d9a11aa7f2c59a18b30e6170 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Wed, 13 Sep 2023 11:11:39 -0500 Subject: [PATCH 2/4] Fix description (#10415) --- .github/ISSUE_TEMPLATE/04-customer-feedback.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/04-customer-feedback.yml b/.github/ISSUE_TEMPLATE/04-customer-feedback.yml index 379510776ac3..011200e9d057 100644 --- a/.github/ISSUE_TEMPLATE/04-customer-feedback.yml +++ b/.github/ISSUE_TEMPLATE/04-customer-feedback.yml @@ -49,7 +49,7 @@ body: required: false attributes: label: Environment - description: >- + description: | Run the following command and paste the results in the textbox below. ```powershell From c28172d6f0da74398abc32692fb99912555c6805 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Wed, 13 Sep 2023 16:33:43 -0500 Subject: [PATCH 3/4] Update template (#10417) * Update template * formatting --- .../ISSUE_TEMPLATE/04-customer-feedback.yml | 25 ++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/04-customer-feedback.yml b/.github/ISSUE_TEMPLATE/04-customer-feedback.yml index 011200e9d057..377347a6dd22 100644 --- a/.github/ISSUE_TEMPLATE/04-customer-feedback.yml +++ b/.github/ISSUE_TEMPLATE/04-customer-feedback.yml @@ -50,10 +50,33 @@ body: attributes: label: Environment description: | - Run the following command and paste the results in the textbox below. + Provide information about your environment. For example, copy the output from the following commands (as appropriate) to show the configuration of your environment. ```powershell $PSVersionTable Get-Module ``` render: console + placeholder: >- + PS> $PSVersionTable + + Name Value + ---- ----- + PSVersion 7.4.0-preview.5 + PSEdition Core + GitCommitId 7.4.0-preview.5 + OS Microsoft Windows 10.0.22621 + Platform Win32NT + PSCompatibleVersions {1.0, 2.0, 3.0, 4.0…} + PSRemotingProtocolVersion 2.3 + SerializationVersion 1.1.0.1 + WSManStackVersion 3.0 + + PS> Get-Module + + ModuleType Version PreRelease Name ExportedCommands + ---------- ------- ---------- ---- ---------------- + Manifest 7.0.0.0 Microsoft.PowerShell.Management {Add-Content, Clear-Content, Clear-Item, Clear-It… + Binary 0.9.0 rc1 Microsoft.PowerShell.PSResourceGet {Find-PSResource, Get-InstalledPSResource, Get-PS… + Manifest 7.0.0.0 Microsoft.PowerShell.Utility {Add-Member, Add-Type, Clear-Variable, Compare-Ob… + Script 2.3.2 beta2 PSReadLine {Get-PSReadLineKeyHandler, Get-PSReadLineOption, … From 74a46c4002fe758a28c3b005d13ae4b7159fb3e4 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Wed, 13 Sep 2023 16:47:23 -0500 Subject: [PATCH 4/4] Update template (#10419) --- .github/ISSUE_TEMPLATE/04-customer-feedback.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/04-customer-feedback.yml b/.github/ISSUE_TEMPLATE/04-customer-feedback.yml index 377347a6dd22..12f5fad50e0e 100644 --- a/.github/ISSUE_TEMPLATE/04-customer-feedback.yml +++ b/.github/ISSUE_TEMPLATE/04-customer-feedback.yml @@ -57,7 +57,7 @@ body: Get-Module ``` render: console - placeholder: >- + placeholder: | PS> $PSVersionTable Name Value