diff --git a/.github/ISSUE_TEMPLATE/Document_New_Feature.md b/.github/ISSUE_TEMPLATE/Document_New_Feature.md deleted file mode 100644 index 5dd75b3270a4..000000000000 --- a/.github/ISSUE_TEMPLATE/Document_New_Feature.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -name: Document new feature or change in behavior 🆕 -about: Document a new feature or changed behavior -title: "Document Request" -labels: doc-idea -assignees: '' ---- - - -# Summary of the new document or enhancement - -- List of articles that need to be updated: -- New articles that need to be created: -- Link(s) to related code PR(s) in the PowerShell/PowerShell repo: -- Link(s) to related issue(s) in the PowerShell/PowerShell repo: - -## Description of what changed - diff --git a/.github/ISSUE_TEMPLATE/Documentation_Issue.md b/.github/ISSUE_TEMPLATE/Documentation_Issue.md deleted file mode 100644 index 2a1ccd3921f3..000000000000 --- a/.github/ISSUE_TEMPLATE/Documentation_Issue.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -name: Documentation Issue 📚 -about: Problems with PowerShell documentation -title: "Documentation Issue" -labels: question -assignees: '' ---- - -# Documentation Issue - - -## Context of the issue - -- URL to the article (Docs or GitHub URL): -- Issue affects the following content (check all that apply): - -**Conceptual content** -- [ ] Overview and Install -- [ ] Learning PowerShell - - [ ] PowerShell 101 - - [ ] Deep dives - - [ ] Remoting -- [ ] Release notes (What's New) -- [ ] Windows PowerShell - - WMF, ISE, release notes, etc. -- [ ] DSC articles -- [ ] Community resources -- [ ] Sample scripts -- [ ] Gallery articles -- [ ] Scripting and development - - [ ] Legacy SDK - -**Cmdlet reference & about_ topics** -- [ ] Preview content -- [ ] Version 7.2 content -- [ ] Version 7.1 content -- [ ] Version 7.0 content -- [ ] Version 5.1 content - -- Is the issue specific to a platform (Y/N - Win/macOS/Linux): - -## Detailed description of the issue - - diff --git a/.github/ISSUE_TEMPLATE/New_Document.yml b/.github/ISSUE_TEMPLATE/New_Document.yml new file mode 100644 index 000000000000..15a47cf05b2e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/New_Document.yml @@ -0,0 +1,42 @@ +name: New Document Request/Idea 🆕 +description: Suggest a new document or major rewrite of an existing one. +labels: doc-idea +body: +- type: checkboxes + attributes: + label: Prerequisites + options: + - label: Write a descriptive title. + required: true + - label: Search the existing issues. + required: true +- type: textarea + attributes: + label: Summary of the new document or enhancement + description: > + A clear and concise description of purpose the new document. Why it is needed? + What gap is it filling? Who is the intended audience? What is the intended + scenario being addressed? + placeholder: > + Try formulating it in user story style. 'As a user I need a document about X so that I + can Y.' with X being the problem or scenario and Y being the purpose and/or target audience + for the document. + validations: + required: true +- type: input + attributes: + label: Proposed title + validations: + required: true +- type: input + attributes: + label: Proposed location in the TOC + validations: + required: false +- type: textarea + attributes: + label: List of related articles to link to + description: Provide a list of files that need to be updated. + placeholder: Enter the Docs or GitHub URL to the article to be updated. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/New_Document_Request.md b/.github/ISSUE_TEMPLATE/New_Document_Request.md deleted file mode 100644 index 435049a5441a..000000000000 --- a/.github/ISSUE_TEMPLATE/New_Document_Request.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: New Document Request/Idea 🚀 -about: Suggest a new document or major rewrite of an existing one -title: "Document Request" -labels: doc-idea -assignees: '' - ---- - -# Summary of the new document or enhancement - - - -Details of requested document: - -- Proposed title: -- Propose location in the TOC: -- Target audience: -- Purpose or scenario: - _or_ - Proposed changes/additions to existing article: -- List of related articles to link to: diff --git a/.github/ISSUE_TEMPLATE/New_Feature.yml b/.github/ISSUE_TEMPLATE/New_Feature.yml new file mode 100644 index 000000000000..16b9525b0267 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/New_Feature.yml @@ -0,0 +1,39 @@ +name: Describe new feature or change in behavior 🚀 +description: Update existing documentation for a change in behavior or add new documentation for a new feature. +labels: doc-idea +body: +- type: checkboxes + attributes: + label: Prerequisites + options: + - label: Write a descriptive title. + required: true + - label: Search the existing issues. + required: true +- type: textarea + attributes: + label: Summary of the new feature or changed behavior + description: > + A clear and concise description of change. + placeholder: > + Describe the impact of the change and examples, if possible. Include new and changed + parameters and changed output. Put code and output inside ``` blocks. + validations: + required: true +- type: textarea + attributes: + label: List of articles that need to be updated + description: Provide a list of files that need to be updated. + placeholder: Enter the Docs or GitHub URL to the article to be updated. +- type: input + attributes: + label: Link to related PR in PowerShell/PowerShell repo + placeholder: PowerShell/PowerShell#12345 + validations: + required: true +- type: input + attributes: + label: Link to related Issues in PowerShell/PowerShell repo + placeholder: PowerShell/PowerShell#12345 + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/New_Issue.yml b/.github/ISSUE_TEMPLATE/New_Issue.yml new file mode 100644 index 000000000000..b453aa078b5a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/New_Issue.yml @@ -0,0 +1,58 @@ +name: Documentation issue report 🐛 +description: Report an issue with current documentation. +labels: doc-bug +body: +- type: markdown + attributes: + value: | + Use this template to report issues with documentation. This can include typos, + technical and factual errors, grammar, spelling, formatting, presentation, etc. + + Support questions should be posted to community support forums. See the [Community support](https://docs.microsoft.com/powershell/scripting/community/community-support) page. +- type: checkboxes + attributes: + label: Prerequisites + options: + - label: Write a descriptive title. + required: true + - label: Search the existing issues. + required: true + - label: I am reporting the documentation problem for version of PowerShell I am using. + required: true +- type: dropdown + attributes: + label: Version + description: What version of the documentation is affected? (select all that apply) + multiple: true + options: + - 5.1 + - 7.0 + - 7.1 + - 7.2 + - Preview version + validations: + required: true +- type: input + attributes: + label: Link to affected document + placeholder: Enter a GitHub or Docs URL to the article. + validations: + required: true +- type: textarea + attributes: + label: Description of the documentation error + description: > + Describe the error in the documentation. Include details about what you this is wrong. + placeholder: | + Example 3 has invalid parameters. + + List of steps, sample code, or failing test to support your claim. + validations: + required: true +- type: textarea + attributes: + label: Suggested fix + description: > + How would you change the document to make it correct. + validations: + required: false