Skip to content

Commit

Permalink
Configure OSS Feedback (#200)
Browse files Browse the repository at this point in the history
  • Loading branch information
sdwheeler authored Sep 28, 2023
1 parent a096047 commit b8e7197
Show file tree
Hide file tree
Showing 2 changed files with 127 additions and 4 deletions.
99 changes: 99 additions & 0 deletions .github/ISSUE_TEMPLATE/04-customer-feedback.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
name: "📄 Feedback control template"
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: 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
description: Version independent document Id
- type: markdown
attributes:
value: "## 🎁Feedback🎁"
- type: textarea
id: feedback
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: |
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, …
32 changes: 28 additions & 4 deletions dsc/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,34 @@
"feedback_product_url": {
"**/dsc-1.1/**/*.md": "https://support.microsoft.com/windows/send-feedback-to-microsoft-with-the-feedback-hub-app-f59187f8-8739-22d6-ba93-f66612949332",
"**/dsc-2.0/**/*.md": "https://github.com/PowerShell/PSDesiredStateConfiguration/issues/new/choose",
"**/dsc-3.0/**/*.md": "https://github.com/PowerShell/PSDesiredStateConfiguration/issues/new/choose"
"**/dsc-3.0/**/*.md": "https://github.com/PowerShell/DSC/issues/new/choose"
},
"feedback_system": {
"**/*": "OpenSource"
},
"open_source_feedback_contributorGuideUrl": {
"**/*": "https://learn.microsoft.com/powershell/scripting/community/contributing/powershell-style-guide"
},
"open_source_feedback_issueTitle": {
"**/*": "Customer feedback - "
},
"open_source_feedback_issueLabels": {
"**/*": "needs-triage"
},
"open_source_feedback_issueUrl": {
"**/*": "https://github.com/MicrosoftDocs/PowerShell-Docs-DSC/issues/new?template=04-customer-feedback.yml"
},
"open_source_feedback_productDescription": {
"**/*": "The DSC documentation is open source. Select a link to provide feedback:"
},
"open_source_feedback_productLogoLightUrl": {
"**/*": "https://learn.microsoft.com/media/logos/logo-powershell-core.svg"
},
"open_source_feedback_productLogoDarkUrl": {
"**/*": "https://learn.microsoft.com/media/logos/logo-powershell-core.svg"
},
"open_source_feedback_productName": {
"**/*": "DSC feedback"
},
"ms.topic": {
"docs-conceptual/**": "conceptual",
Expand All @@ -36,9 +63,6 @@
"author": "sdwheeler",
"breadcrumb_path": "/powershell/dsc/breadcrumb/toc.json",
"extendBreadcrumb": true,
"feedback_github_repo": "MicrosoftDocs/PowerShell-Docs-DSC",
"feedback_product_url": "https://github.com/PowerShell/PSDesiredStateConfiguration/issues/new/choose",
"feedback_system": "GitHub",
"hideScope": false,
"manager": "jasongroce",
"ms.author": "sewhee",
Expand Down

0 comments on commit b8e7197

Please sign in to comment.