From 8ad4ff7e6e075fcc77411dc9181c3918fa9382f4 Mon Sep 17 00:00:00 2001 From: Andrew Schwartzmeyer Date: Thu, 28 Oct 2021 09:50:43 -0700 Subject: [PATCH 1/2] Fix links to work on GitHub While we work through automating this for publishing. --- docs/Cmdlets/Invoke-ScriptAnalyzer.md | 2 +- docs/Rules/ProvideCommentHelp.md | 6 +++--- docs/Rules/UseApprovedVerbs.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/Cmdlets/Invoke-ScriptAnalyzer.md b/docs/Cmdlets/Invoke-ScriptAnalyzer.md index 2263f165b..2a3d0d791 100644 --- a/docs/Cmdlets/Invoke-ScriptAnalyzer.md +++ b/docs/Cmdlets/Invoke-ScriptAnalyzer.md @@ -514,7 +514,7 @@ following keys: The keys and values in the profile are interpreted as if they were standard parameters and values of `Invoke-ScriptAnalyzer`, similar to splatting. For more information, see -[about_Splatting](/powershell/module/microsoft.powershell.com/about/about_splatting). +[about_Splatting](https://docs.microsoft.com/powershell/module/microsoft.powershell.com/about/about_splatting). ```yaml Type: Object diff --git a/docs/Rules/ProvideCommentHelp.md b/docs/Rules/ProvideCommentHelp.md index 9e9a4305a..e359078be 100644 --- a/docs/Rules/ProvideCommentHelp.md +++ b/docs/Rules/ProvideCommentHelp.md @@ -17,9 +17,9 @@ presence of comment based help and not on the validity or format. For assistance on comment based help, use the command `Get-Help about_comment_based_help` or the following articles: -- [Writing Comment-based Help](/powershell/scripting/developer/help/writing-comment-based-help-topics) -- [Writing Help for PowerShell Cmdlets](/powershell/scripting/developer/help/writing-help-for-windows-powershell-cmdlets) -- [Create XML-based help using PlatyPS](/powershell/scripting/dev-cross-plat/create-help-using-platyps) +- [Writing Comment-based Help](https://docs.microsoft.com/powershell/scripting/developer/help/writing-comment-based-help-topics) +- [Writing Help for PowerShell Cmdlets](https://docs.microsoft.com/powershell/scripting/developer/help/writing-help-for-windows-powershell-cmdlets) +- [Create XML-based help using PlatyPS](https://docs.microsoft.com/powershell/scripting/dev-cross-plat/create-help-using-platyps) ## Configuration diff --git a/docs/Rules/UseApprovedVerbs.md b/docs/Rules/UseApprovedVerbs.md index 3d71188d8..e0be49256 100644 --- a/docs/Rules/UseApprovedVerbs.md +++ b/docs/Rules/UseApprovedVerbs.md @@ -16,7 +16,7 @@ All cmdlets must used approved verbs. Approved verbs can be found by running the command `Get-Verb`. Additional documentation on approved verbs can be found in the microsoft docs page -[Approved Verbs for PowerShell Commands](/powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands). +[Approved Verbs for PowerShell Commands](https://docs.microsoft.com/powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands). Some unapproved verbs are documented on the approved verbs page and point to approved alternatives. Try searching for the verb you used to find its approved form. For example, searching for `Read`, `Open`, or `Search` leads you to `Get`. From 905891522149035b58898449e198bd81443f0f1a Mon Sep 17 00:00:00 2001 From: Andrew Schwartzmeyer Date: Thu, 28 Oct 2021 09:55:05 -0700 Subject: [PATCH 2/2] Fix `about_Splatting` link too --- docs/Cmdlets/Invoke-ScriptAnalyzer.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Cmdlets/Invoke-ScriptAnalyzer.md b/docs/Cmdlets/Invoke-ScriptAnalyzer.md index 2a3d0d791..87836f69f 100644 --- a/docs/Cmdlets/Invoke-ScriptAnalyzer.md +++ b/docs/Cmdlets/Invoke-ScriptAnalyzer.md @@ -514,7 +514,7 @@ following keys: The keys and values in the profile are interpreted as if they were standard parameters and values of `Invoke-ScriptAnalyzer`, similar to splatting. For more information, see -[about_Splatting](https://docs.microsoft.com/powershell/module/microsoft.powershell.com/about/about_splatting). +[about_Splatting](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_splatting). ```yaml Type: Object