From 9530c5e887256d8401cad03a9af32d4c2d541633 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Mon, 11 Jul 2022 09:04:53 -0500 Subject: [PATCH 1/2] Edits based on new linting rules --- .../advanced/using-crescendo-cmdlets.md | 23 +++++++++---------- .../Get-ScriptAnalyzerRule.md | 4 ++-- .../ps-modules/PlatyPS/New-ExternalHelp.md | 12 +++++----- .../ps-modules/PlatyPS/New-ExternalHelpCab.md | 11 +++++---- .../ps-modules/PlatyPS/New-MarkdownHelp.md | 19 +++++++-------- 5 files changed, 35 insertions(+), 34 deletions(-) diff --git a/reference/docs-conceptual/Crescendo/advanced/using-crescendo-cmdlets.md b/reference/docs-conceptual/Crescendo/advanced/using-crescendo-cmdlets.md index 4e482b0..13fa849 100644 --- a/reference/docs-conceptual/Crescendo/advanced/using-crescendo-cmdlets.md +++ b/reference/docs-conceptual/Crescendo/advanced/using-crescendo-cmdlets.md @@ -8,9 +8,9 @@ title: Create a Crescendo configuration using the Crescendo cmdlets The Crescendo module includes a set of cmdlets that create various Crescendo object types. You can use these cmdlets to create a Crescendo configuration without the need to manually edit a JSON file. -During the design of Crescendo, these cmdlets were created before the decision that module and -cmdlet creation could be better served by a declarative approach. Their utility was still obvious, -so the decision was made to support both approaches. +During the design of Crescendo, we created these cmdlets before the decision that module and cmdlet +creation could be better served by a declarative approach. Their utility was still appreciated, so +we decided to support both approaches. > [!IMPORTANT] > Since developer tools like Visual Studio Code (VS Code) provide IntelliSense based on the JSON @@ -204,15 +204,14 @@ Export-CrescendoModule -ConfigurationFile vssadmin.json -ModuleName .\vssadmin.p ## Advanced use cases The Crescendo cmdlets are powerful tools that can be used in advanced scenarios to create -configurations and build modules. There are several advanced examples that come bundled with the -Crescendo module. These can be found in the `Experimental\HelpParsers` folder of the -**Microsoft.PowerShell.Crescendo** module. These experimental examples show how you can parse the -help output of a command-line tool and use that information to create a Crescendo configuration for -a module that wrap the tool. The [README.md][README.md] file provides a detailed explanation of the -design of these help parsers. - -Examples like these help parsers could be used in a CI/CD pipeline to build new versions of a module -when the command-line tool changes. +configurations and build modules. There are several advanced in the `Experimental\HelpParsers` +folder of the **Microsoft.PowerShell.Crescendo** module. These experimental examples show how you +can parse the help output of a command-line tool and use that information to create a Crescendo +configuration for a module that wrap the tool. The [README.md][README.md] file provides a detailed +explanation of the design of these help parsers. + +You could use these help parsers in a CI/CD pipeline to build new versions of a module when the +command-line tool changes. [blog]: https://devblogs.microsoft.com/powershell-community/tag/crescendo/ diff --git a/reference/ps-modules/PSScriptAnalyzer/Get-ScriptAnalyzerRule.md b/reference/ps-modules/PSScriptAnalyzer/Get-ScriptAnalyzerRule.md index ccb56c6..2a6e1de 100644 --- a/reference/ps-modules/PSScriptAnalyzer/Get-ScriptAnalyzerRule.md +++ b/reference/ps-modules/PSScriptAnalyzer/Get-ScriptAnalyzerRule.md @@ -92,7 +92,7 @@ Enter the path to a .NET assembly or module that contains Script Analyzer rules. one value, but wildcards are supported. To get rules in subdirectories of the path, use the **RecurseCustomRulePath** parameter. -You can create custom rules by using a custom .NET assembly or a PowerShell module, such as the +You can create custom rules using a custom .NET assembly or a PowerShell module, such as the [Community Analyzer Rules](https://github.com/PowerShell/PSScriptAnalyzer/blob/development/Tests/Engine/CommunityAnalyzerRules/CommunityAnalyzerRules.psm1) in the GitHub repository. @@ -173,7 +173,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### None -You cannot pipe input to this cmdlet. +You can't pipe input to this cmdlet. ## OUTPUTS diff --git a/reference/ps-modules/PlatyPS/New-ExternalHelp.md b/reference/ps-modules/PlatyPS/New-ExternalHelp.md index b0f03b9..fabdbf9 100644 --- a/reference/ps-modules/PlatyPS/New-ExternalHelp.md +++ b/reference/ps-modules/PlatyPS/New-ExternalHelp.md @@ -21,9 +21,9 @@ New-ExternalHelp -Path -OutputPath [-ApplicableTag Date: Mon, 11 Jul 2022 09:17:18 -0500 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Mikey Lombardi (He/Him) --- .../Crescendo/advanced/using-crescendo-cmdlets.md | 4 ++-- .../ps-modules/PSScriptAnalyzer/Get-ScriptAnalyzerRule.md | 2 +- reference/ps-modules/PlatyPS/New-MarkdownHelp.md | 6 +++--- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/reference/docs-conceptual/Crescendo/advanced/using-crescendo-cmdlets.md b/reference/docs-conceptual/Crescendo/advanced/using-crescendo-cmdlets.md index 13fa849..149e197 100644 --- a/reference/docs-conceptual/Crescendo/advanced/using-crescendo-cmdlets.md +++ b/reference/docs-conceptual/Crescendo/advanced/using-crescendo-cmdlets.md @@ -204,10 +204,10 @@ Export-CrescendoModule -ConfigurationFile vssadmin.json -ModuleName .\vssadmin.p ## Advanced use cases The Crescendo cmdlets are powerful tools that can be used in advanced scenarios to create -configurations and build modules. There are several advanced in the `Experimental\HelpParsers` +configurations and build modules. There are several advanced examples in the `Experimental\HelpParsers` folder of the **Microsoft.PowerShell.Crescendo** module. These experimental examples show how you can parse the help output of a command-line tool and use that information to create a Crescendo -configuration for a module that wrap the tool. The [README.md][README.md] file provides a detailed +configuration for a module that wraps the tool. The [README.md][README.md] file provides a detailed explanation of the design of these help parsers. You could use these help parsers in a CI/CD pipeline to build new versions of a module when the diff --git a/reference/ps-modules/PSScriptAnalyzer/Get-ScriptAnalyzerRule.md b/reference/ps-modules/PSScriptAnalyzer/Get-ScriptAnalyzerRule.md index 2a6e1de..5aa735e 100644 --- a/reference/ps-modules/PSScriptAnalyzer/Get-ScriptAnalyzerRule.md +++ b/reference/ps-modules/PSScriptAnalyzer/Get-ScriptAnalyzerRule.md @@ -92,7 +92,7 @@ Enter the path to a .NET assembly or module that contains Script Analyzer rules. one value, but wildcards are supported. To get rules in subdirectories of the path, use the **RecurseCustomRulePath** parameter. -You can create custom rules using a custom .NET assembly or a PowerShell module, such as the +You can create custom rules using a .NET assembly or a PowerShell module, such as the [Community Analyzer Rules](https://github.com/PowerShell/PSScriptAnalyzer/blob/development/Tests/Engine/CommunityAnalyzerRules/CommunityAnalyzerRules.psm1) in the GitHub repository. diff --git a/reference/ps-modules/PlatyPS/New-MarkdownHelp.md b/reference/ps-modules/PlatyPS/New-MarkdownHelp.md index a35c823..ab5fcd1 100644 --- a/reference/ps-modules/PlatyPS/New-MarkdownHelp.md +++ b/reference/ps-modules/PlatyPS/New-MarkdownHelp.md @@ -60,7 +60,7 @@ Mode LastWriteTime Length Name -a---- 5/22/2016 6:53 PM 664 Command03.md ``` -The first command creates a function named Command03 using standard Windows PowerShell syntax. +The first command creates a function named `Command03` using standard Windows PowerShell syntax. The second command creates help for that stub function in the .\docs folder. @@ -86,7 +86,7 @@ Mode LastWriteTime Length Name -a---- 5/22/2016 6:54 PM 1630 Update-MarkdownHelpSchema.md ``` -The first command loads the PlatyPS module into the current session using the `Import-Module` +The first command loads the **PlatyPS** module into the current session using the `Import-Module` cmdlet. The second command creates help for all the cmdlets in the PlatyPS module. It stores them in the @@ -381,7 +381,7 @@ Accept wildcard characters: False Indicates that this cmdlet creates a module page in the output folder. This file has the name that the **ModuleName** parameter specifies. If you didn't specify that parameter, the cmdlet supplies -the default name MamlModule. You can overwrite this setting using **ModulePagePath** which allows +the default name `MamlModule`. You can overwrite this setting using **ModulePagePath** which allows you to define different path for module page ```yaml