Skip to content

Commit

Permalink
Add OSS Feedback configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
sdwheeler committed Sep 28, 2023
1 parent c8b5862 commit 68cdc16
Show file tree
Hide file tree
Showing 2 changed files with 95 additions and 1 deletion.
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/04-customer-feedback.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
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: "## 🎁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: feedback
validations:
required: true
attributes:
label: Feedback
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: 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
28 changes: 27 additions & 1 deletion reference/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,33 @@
"ps-modules/PlatyPS/**.yml": "https://github.com/PowerShell/platyPS/issues/new/choose",
"ps-modules/PSScriptAnalyzer/**.yml": "https://github.com/PowerShell/PSScriptAnalyzer/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-Modules/issues/new?template=04-customer-feedback.yml"
},
"open_source_feedback_productDescription": {
"**/*": "These PowerShell modules are open source projects. 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": {
"**/*": "PowerShell feedback"
},
"manager": {
"**/**": "mkluck"
},
Expand Down Expand Up @@ -64,7 +91,6 @@
"apiPlatform": "powershell",
"breadcrumb_path": "/powershell/utility-modules/breadcrumb/toc.json",
"feedback_github_repo": "MicrosoftDocs/PowerShell-Docs-Modules",
"feedback_system": "GitHub",
"ms.devlang": "powershell",
"ms.prod": "powershell",
"titleSuffix": "PowerShell",
Expand Down

0 comments on commit 68cdc16

Please sign in to comment.