From f206b363d66fa1156705ed86995b518ae7d492eb Mon Sep 17 00:00:00 2001 From: Tyler James Leonhardt Date: Fri, 21 Jun 2019 18:34:00 -0700 Subject: [PATCH 1/2] Add quick steps for adding docs to cmdlets --- .github/CONTRIBUTING.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 20a7a7c3335..35d3401f5fd 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -41,6 +41,32 @@ Please read the rest of this document to ensure a smooth contribution process. Please see the [Contributor Guide in `MicrosoftDocs/PowerShell-Docs`](https://github.com/MicrosoftDocs/PowerShell-Docs/blob/staging/CONTRIBUTING.md). +#### Quick steps if you're changing an existing cmdlet + +If you made a change to an existing cmdlet and would like to update the documentation using PlatyPS, +here are the quick steps: + +1. Install +`PlatyPS` +if you don't have it - +`Install-Module PlatyPS`. +2. Clone the +[`MicrosoftDocs/PowerShell-Docs`](https://github.com/MicrosoftDocs/PowerShell-Docs) +repo if you don't already have it. +3. Start your local build of PowerShell +(with the change to the cmdlet you made). +4. Find the cmdlet's markdown file in PowerShell Docs - usually under +`PowerShell-Docs/reference///.md` +(Ex. `PowerShell-Docs/reference/7/Microsoft.PowerShell.Utility/Select-String.md`) +5. Run +`Update-MarkdownHelp -Path ` +which will update the documentation for you. +6. Make any additional changes needed for the cmdlet to be properly documented. +7. Send a Pull Request to the PowerShell Docs repo with the changes that +`PlatyPS` +made. +8. Link your Docs PR to your original change PR. + ### Contributing to documentation related to maintaining or contributing to the PowerShell project * When writing Markdown documentation, use [semantic linefeeds][]. From 9ce64e68419a04209cf496afc988e99f253e203f Mon Sep 17 00:00:00 2001 From: Tyler Leonhardt Date: Mon, 24 Jun 2019 21:32:59 -0700 Subject: [PATCH 2/2] switch to all 1s --- .github/CONTRIBUTING.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 35d3401f5fd..075d5186e30 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -46,26 +46,26 @@ Please see the [Contributor Guide in `MicrosoftDocs/PowerShell-Docs`](https://gi If you made a change to an existing cmdlet and would like to update the documentation using PlatyPS, here are the quick steps: -1. Install +1. Install `PlatyPS` if you don't have it - `Install-Module PlatyPS`. -2. Clone the +1. Clone the [`MicrosoftDocs/PowerShell-Docs`](https://github.com/MicrosoftDocs/PowerShell-Docs) repo if you don't already have it. -3. Start your local build of PowerShell +1. Start your local build of PowerShell (with the change to the cmdlet you made). -4. Find the cmdlet's markdown file in PowerShell Docs - usually under +1. Find the cmdlet's markdown file in PowerShell Docs - usually under `PowerShell-Docs/reference///.md` (Ex. `PowerShell-Docs/reference/7/Microsoft.PowerShell.Utility/Select-String.md`) -5. Run +1. Run `Update-MarkdownHelp -Path ` which will update the documentation for you. -6. Make any additional changes needed for the cmdlet to be properly documented. -7. Send a Pull Request to the PowerShell Docs repo with the changes that +1. Make any additional changes needed for the cmdlet to be properly documented. +1. Send a Pull Request to the PowerShell Docs repo with the changes that `PlatyPS` made. -8. Link your Docs PR to your original change PR. +1. Link your Docs PR to your original change PR. ### Contributing to documentation related to maintaining or contributing to the PowerShell project