From 332c02d720e58a53f55507b3fa588b00ff62e582 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Thu, 28 Sep 2023 09:58:36 -0500 Subject: [PATCH 1/2] Ass OSS Feedback configuration --- .../ISSUE_TEMPLATE/04-customer-feedback.yml | 68 ++++++++++++++ powershell-gallery/docfx.json | 89 +++++++++---------- 2 files changed, 108 insertions(+), 49 deletions(-) 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 0000000..3b908eb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04-customer-feedback.yml @@ -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 diff --git a/powershell-gallery/docfx.json b/powershell-gallery/docfx.json index 7718ce8..590019f 100644 --- a/powershell-gallery/docfx.json +++ b/powershell-gallery/docfx.json @@ -26,78 +26,69 @@ "exportViewModel": true, "externalReference": [], "fileMetadata": { - "author": { - "**/**.md": "sdwheeler", - "**/**.yml": "sdwheeler" - }, "feedback_product_url": { - "docs-conceptual/gallery/**/**.md": "https://github.com/powershell/powershellgallery/issues/new" + "docs-conceptual/concepts/**/*": "https://github.com/powershell/powershellgallery/issues/new", + "docs-conceptual/how-to/**/*": "https://github.com/powershell/powershellgallery/issues/new", + "docs-conceptual/powershellget/**/*": "https://github.com/powershell/psresourceget/issues/new" + }, + "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" }, - "manager": { - "**/**": "jasongroce" + "open_source_feedback_issueUrl": { + "**/*": "https://github.com/MicrosoftDocs/PowerShell-Docs-Modules/issues/new?template=04-customer-feedback.yml" }, - "ms.author": { - "**/**.md": "sewhee", - "**/**.yml": "sewhee" + "open_source_feedback_productDescription": { + "**/powershellget*/**/*": "PowerShellGet is an open source project. 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": { + "powershellget-*/**/*": "PowerShellGet feedback", + "docs-conceptual/concepts/**/*": "PowerShell Gallery feedback", + "docs-conceptual/how-to/**/*": "PowerShell Gallery feedback" }, "ms.prod": { - "**/**.md": "powershell", - "**/**.yml": "powershell" + "**/*": "powershell" }, "ms.technology": { - "powershellget-1.x/**.md": "powershell-conceptual", - "powershellget-1.x/**.yml": "powershell-cmdlets", - "powershellget-2.x/**.md": "powershell-conceptual", - "powershellget-2.x/**.yml": "powershell-cmdlets", - "powershellget-3.x/**.md": "powershell-conceptual", - "powershellget-3.x/**.yml": "powershell-cmdlets", - "docs-conceptual/**/**.md": "powershell-conceptual" + "powershellget-*/**.md": "powershell-conceptual", + "powershellget-*/**.yml": "powershell-cmdlets" }, "ms.tgt_pltfr": { - "**/**": "windows, macos, linux" + "**/*": "windows, macos, linux" }, "ms.topic": { - "powershellget-1.x/**.md": "managed-reference", - "powershellget-1.x/**.yml": "managed-reference", - "powershellget-2.x/**.md": "managed-reference", - "powershellget-2.x/**.yml": "managed-reference", - "powershellget-3.x/**.md": "managed-reference", - "powershellget-3.x/**.yml": "managed-reference", - "docs-conceptual/**/**.md": "conceptual", + "powershellget-*/*": "managed-reference" }, "products": { - "docs-conceptual/**/**.md": [ - "https://authoring-docs-microsoft.poolparty.biz/devrel/2bdae855-045f-4535-b365-7b2e23824328", - "https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3" - ], - "powershellget-1.x/**.md": [ - "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", - "https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3" - ], - "powershellget-1.x/**.yml": [ - "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", - "https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3" - ], - "powershellget-2.x/**.md": [ + "docs-conceptual/**/*": [ "https://authoring-docs-microsoft.poolparty.biz/devrel/2bdae855-045f-4535-b365-7b2e23824328", "https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3" ], - "powershellget-2.x/**.yml": [ + "powershellget-*/*.md": [ "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", "https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3" ], - "powershellget-3.x/**.md": [ + "powershellget-*/*.yml": [ "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", "https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3" ], - "powershellget-3.x/**.yml": [ - "https://authoring-docs-microsoft.poolparty.biz/devrel/2bdae855-045f-4535-b365-7b2e23824328", - "https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3" - ] }, "social_image_url": { - "**/**.md": "https://learn.microsoft.com/media/logos/logo-powershell-social.png", - "**/**.yml": "https://learn.microsoft.com/media/logos/logo-powershell-social.png" + "**/*": "https://learn.microsoft.com/media/logos/logo-powershell-social.png" } }, "globalMetadata": { @@ -105,7 +96,7 @@ "extendBreadcrumb": true, "feedback_github_repo": "MicrosoftDocs/PowerShell-Docs-PSGet", "feedback_product_url": "https://github.com/PowerShell/PowerShellGet/issues/new/choose", - "feedback_system": "GitHub", + "manager": "jasongroce", "ms.author": "sewhee", "ms.devlang": "powershell", "ms.prod": "powershell", From 9ede836baff3c42609e236c5a047cdac0c272e08 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Thu, 28 Sep 2023 10:18:42 -0500 Subject: [PATCH 2/2] fix metadata --- powershell-gallery/docfx.json | 1 + 1 file changed, 1 insertion(+) diff --git a/powershell-gallery/docfx.json b/powershell-gallery/docfx.json index 590019f..21cee32 100644 --- a/powershell-gallery/docfx.json +++ b/powershell-gallery/docfx.json @@ -98,6 +98,7 @@ "feedback_product_url": "https://github.com/PowerShell/PowerShellGet/issues/new/choose", "manager": "jasongroce", "ms.author": "sewhee", + "author": "sdwheeler", "ms.devlang": "powershell", "ms.prod": "powershell", "searchScope": [