Skip to content

Commit e923e16

Browse files
authored
(MAINT) Update URLs for site rebrand (#1844)
* Update URLs for site rebrand * Fix typos * Restore missing site for URLs * Sync change from docs for ShouldProcess
1 parent da2c918 commit e923e16

File tree

11 files changed

+39
-32
lines changed

11 files changed

+39
-32
lines changed

.github/ISSUE_TEMPLATE/config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ blank_issues_enabled: false
22
contact_links:
33
- name: Report a User documentation issue
44
url: https://github.com/MicrosoftDocs/PowerShell-Docs-Modules/issues/new/choose
5-
about: Report issues about the user documentation available on docs.microsoft.com.
5+
about: Report issues about the user documentation available on learn.microsoft.com.

CHANGELOG.MD

+10-8
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@
7676

7777
### Miscellaneous
7878

79-
- Set Assembly version attribute (#1549) (by @JamesWTruher)
79+
- Set Assembly version attribute (#1549) (by @JamesWTruher)
8080

8181
### Documentation
8282

@@ -209,7 +209,7 @@ The PRs for those improvements are:
209209

210210
## [1.18.3](https://github.com/PowerShell/PSScriptAnalyzer/tree/1.18.3) - 2019-09-13
211211

212-
This release adds one more important fix, which prevents a leak of runspaces when repeatedly invoking the PSScriptAnalyzer cmdlets. Furthermore it ups the minimum version of PowerShell Core to `6.2.0` due to `6.1` reaching its [end of life](https://docs.microsoft.com/en-us/powershell/scripting/powershell-support-lifecycle?view=powershell-6#powershell-releases-end-of-life) this month.
212+
This release adds one more important fix, which prevents a leak of runspaces when repeatedly invoking the PSScriptAnalyzer cmdlets. Furthermore it ups the minimum version of PowerShell Core to `6.2.0` due to `6.1` reaching its [end of life](https://learn.microsoft.com/powershell/scripting/install/PowerShell-Support-Lifecycle#powershell-end-of-support-dates) this month.
213213

214214
- Change CommandInfoCache to implement IDisposable and clean up the runspace pool (#1335) (by @JamesWTruher)
215215
- Update Newtonsoft json to 12.0.1 due to PowerShell 6.1 going out of support (#1336) (by @bergmeister)
@@ -275,11 +275,11 @@ The benefit to the user will be some enhancements and fixes in the formatter, es
275275
- Convert compatibility module to binary module, fix compatibility with Azure environments (#1212) (by @rjmholt)
276276
- Prevent .NET members with names differing only by case from crashing the compatibility profiler (#1195) (by @rjmholt)
277277
- Fix compatibility profile query API so that aliases referring to other modules appear (#1194) (by @rjmholt)
278-
278+
279279
- DSC
280280
- Instead of using the first cimClass and then having no superClass, use the first cimClass that has a non-null superClass (#1200) (by @bergmeister, thanks to @ykuijs! for the great collaboration)
281281
- Make `-SaveDscDependency` work on Linux (#1246) (by @bergmeister)
282-
282+
283283
- Enable suppression of custom rules when used together with `-IncludeDefaultRules` to allow all possible scenarios from 1.17.1 and 1.18.0. This removes also the check if the rule name in the suppression attribute can be found because this check is technically not possible in all scenarios (#1245) (by @bergmeister)
284284
- Fix NullReferenceException for class type (#1182) (by @bergmeister)
285285

@@ -492,7 +492,7 @@ Multi-threading efficiency was highly improved leading to a speedup whilst keepi
492492
- Add simple GitHub Pull Request template based off the one for PowerShell Core (#866) (by @bergmeister)
493493
- Add a simple GitHub issue template based on the one of PowerShell Core. (#865, #884) (by @bergmeister)
494494
- Fix Example 7 in Invoke-ScriptAnalyzer.md (#862) (Thanks @sethvs!)
495-
- Use the typewriter apostrophe instead the typographic apostrophe (#855) (Thanks @alexandear!)
495+
- Use the typewriter apostrophe instead the typographic apostrophe (#855) (Thanks @alexandear!)
496496
- Add justification to ReadMe (#848) (Thanks @KevinMarquette!)
497497
- Fix typo in README (#845) (Thanks @misterGF!)
498498

@@ -768,7 +768,8 @@ A big **Thank You!** to the following folks for making PSScriptAnalyzer even bet
768768
### Fixes:
769769
#### Engine:
770770
- Engine update to prevent script based injection attacks
771-
- CustomizedRulePath is now called CustomRulePath – Fixes to handle folder paths
771+
- CustomizedRulePath is now called CustomRulePath
772+
- Fixes to handle folder paths
772773
- Fixes for RecurseCustomRulePath functionality
773774
- Fix to binplace cmdlet help file as part of build process
774775
- ScriptAnalyzer Profile is now called Settings
@@ -786,7 +787,8 @@ A big **Thank You!** to the following folks for making PSScriptAnalyzer even bet
786787
- Update to Credential based rules to validate the presence of CredentialAttribute and PSCredential type
787788

788789
### Documentation:
789-
- Rule & Cmdlet documentation updates – Cmdlet help file addition
790+
- Rule & Cmdlet documentation updates
791+
- Cmdlet help file addition
790792

791793
## [1.1.1](https://github.com/PowerShell/PSScriptAnalyzer/tree/1.1.1) - 2015-11-03
792794
### Features:
@@ -827,7 +829,7 @@ A big **Thank You!** to the following folks for making PSScriptAnalyzer even bet
827829

828830
### Rules:
829831
- New rule to validate the presence of deprecated module manifest fields.
830-
- Removed PSAvoidTrapStatement rule from the builtin set – since this is not deprecated and using trap is a better choice in certain scenarios.
832+
- Removed PSAvoidTrapStatement rule from the builtin set since this is not deprecated and using trap is a better choice in certain scenarios.
831833

832834
### Fixes:
833835
- Verbose Message rule applies to only DSC cmdlet based resources.

PSCompatibilityCollector/Microsoft.PowerShell.CrossCompatibility/Data/Platform/OperatingSystemData.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ public class OperatingSystemData : ICloneable
6969
/// <summary>
7070
/// The Windows SKU identifier, corresponding to
7171
/// the GetProductInfo() sysinfo API:
72-
/// https://docs.microsoft.com/en-us/windows/desktop/api/sysinfoapi/nf-sysinfoapi-getproductinfo
72+
/// https://learn.microsoft.com/windows/desktop/api/sysinfoapi/nf-sysinfoapi-getproductinfo
7373
/// </summary>
7474
[DataMember(EmitDefaultValue = false)]
7575
public uint? SkuId { get; set; }

README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -40,33 +40,33 @@ PowerShell code such as:
4040
## DOCUMENTATION NOTICE
4141

4242
Conceptual user documentation has been moved out of the source code repository and into the
43-
documentation repository so that it can be published on docs.microsoft.com.
43+
documentation repository so that it can be published on learn.microsoft.com.
4444

45-
The goal of this migration is to have the user documentation on docs.microsoft.com. The source code
45+
The goal of this migration is to have the user documentation on learn.microsoft.com. The source code
4646
repository should only contain documentation for the code base, such as how to build the code or how
4747
to contribute to the code.
4848

4949
User documentation that has been migrated:
5050

5151
- Most of the contents of this README can be found in the
52-
[PSScriptAnalyzer overview](https://docs.microsoft.com/powershell/utility-modules/psscriptanalyzer/overview)
52+
[PSScriptAnalyzer overview](https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/overview)
5353
- For cmdlet reference, see
54-
[PSScriptAnalyzer](https://docs.microsoft.com/powershell/module/psscriptanalyzer)
54+
[PSScriptAnalyzer](https://learn.microsoft.com/powershell/module/psscriptanalyzer)
5555
- For rules, see
56-
[Rules overview](https://docs.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/readme)
56+
[Rules overview](https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/readme)
5757
- The `PowerShellBestPractices.md` content has been moved to
58-
[PSScriptAnalyzer rules and recommendations](https://docs.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules-recommendations)
58+
[PSScriptAnalyzer rules and recommendations](https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules-recommendations)
5959
- The `ScriptRuleDocumentation.md` content has been moved to
60-
[Creating custom rules](https://docs.microsoft.com/powershell/utility-modules/psscriptanalyzer/create-custom-rule)
60+
[Creating custom rules](https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/create-custom-rule)
6161

6262
There is one exception - the documentation for the rules and cmdlets will remain in the [docs](docs)
6363
folder to facilitate build testing and to be archived as part of each release. Only the
64-
documentation for the latest release is published on on docs.microsoft.com.
64+
documentation for the latest release is published on on learn.microsoft.com.
6565

6666
## Installation
6767

6868
To install **PSScriptAnalyzer** from the PowerShell Gallery, see
69-
[Installing PSScriptAnalyzer](https://docs.microsoft.com/powershell/utility-modules/psscriptanalyzer/overview#installing-psscriptanalyzer).
69+
[Installing PSScriptAnalyzer](https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/overview#installing-psscriptanalyzer).
7070

7171
To install **PSScriptAnalyzer** from source code:
7272

@@ -190,7 +190,7 @@ Get-TestFailures
190190
## Using PSScriptAnalyzer
191191

192192
The documentation in this section can be found in
193-
[Using PSScriptAnalyzer](https://docs.microsoft.com/powershell/utility-modules/psscriptanalyzer/using-scriptanalyzer).
193+
[Using PSScriptAnalyzer](https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/using-scriptanalyzer).
194194

195195
## Contributions are welcome
196196

build.psm1

+1-1
Original file line numberDiff line numberDiff line change
@@ -546,7 +546,7 @@ function ConvertTo-PortableVersion {
546546
}
547547
}
548548

549-
# see https://docs.microsoft.com/en-us/dotnet/core/tools/global-json for rules
549+
# see https://learn.microsoft.com/dotnet/core/tools/global-json for rules
550550
# on how version checks are done
551551
function Test-SuitableDotnet {
552552
param (

docs/Cmdlets/Get-ScriptAnalyzerRule.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ external help file: Microsoft.Windows.PowerShell.ScriptAnalyzer.dll-Help.xml
33
Module Name: PSScriptAnalyzer
44
ms.custom: PSSA v1.21.0
55
ms.date: 10/07/2021
6-
online version: https://docs.microsoft.com/powershell/module/psscriptanalyzer/get-scriptanalyzerrule?view=ps-modules&wt.mc_id=ps-gethelp
6+
online version: https://learn.microsoft.com/powershell/module/psscriptanalyzer/get-scriptanalyzerrule?view=ps-modules&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
---
99

docs/Cmdlets/Invoke-Formatter.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ external help file: Microsoft.Windows.PowerShell.ScriptAnalyzer.dll-Help.xml
33
Module Name: PSScriptAnalyzer
44
ms.custom: PSSA v1.21.0
55
ms.date: 10/07/2021
6-
online version: https://docs.microsoft.com/powershell/module/psscriptanalyzer/invoke-formatter?view=ps-modules&wt.mc_id=ps-gethelp
6+
online version: https://learn.microsoft.com/powershell/module/psscriptanalyzer/invoke-formatter?view=ps-modules&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
---
99

docs/Cmdlets/Invoke-ScriptAnalyzer.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ external help file: Microsoft.Windows.PowerShell.ScriptAnalyzer.dll-Help.xml
33
Module Name: PSScriptAnalyzer
44
ms.custom: PSSA v1.21.0
55
ms.date: 10/07/2021
6-
online version: https://docs.microsoft.com/powershell/module/psscriptanalyzer/invoke-scriptanalyzer?view=ps-modules&wt.mc_id=ps-gethelp
6+
online version: https://learn.microsoft.com/powershell/module/psscriptanalyzer/invoke-scriptanalyzer?view=ps-modules&wt.mc_id=ps-gethelp
77
schema: 2.0.0
88
---
99

@@ -514,7 +514,7 @@ following keys:
514514

515515
The keys and values in the profile are interpreted as if they were standard parameters and values of
516516
`Invoke-ScriptAnalyzer`, similar to splatting. For more information, see
517-
[about_Splatting](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_splatting).
517+
[about_Splatting](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_splatting).
518518

519519
```yaml
520520
Type: Object

docs/Rules/ProvideCommentHelp.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ presence of comment based help and not on the validity or format.
1717
For assistance on comment based help, use the command `Get-Help about_comment_based_help` or the
1818
following articles:
1919

20-
- [Writing Comment-based Help](https://docs.microsoft.com/powershell/scripting/developer/help/writing-comment-based-help-topics)
21-
- [Writing Help for PowerShell Cmdlets](https://docs.microsoft.com/powershell/scripting/developer/help/writing-help-for-windows-powershell-cmdlets)
22-
- [Create XML-based help using PlatyPS](https://docs.microsoft.com/powershell/scripting/dev-cross-plat/create-help-using-platyps)
20+
- [Writing Comment-based Help](https://learn.microsoft.com/powershell/scripting/developer/help/writing-comment-based-help-topics)
21+
- [Writing Help for PowerShell Cmdlets](https://learn.microsoft.com/powershell/scripting/developer/help/writing-help-for-windows-powershell-cmdlets)
22+
- [Create XML-based help using PlatyPS](https://learn.microsoft.com/powershell/utility-modules/platyps/create-help-using-platyps)
2323

2424
## Configuration
2525

docs/Rules/ShouldProcess.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ but makes no calls to `ShouldProcess` or it calls `ShouldProcess` but does not d
1818

1919
For more information, see the following articles:
2020

21-
- [about_Functions_Advanced_Methods](/powershell/module/microsoft.powershell.core/about/about_functions_advanced_methods)
22-
- [about_Functions_CmdletBindingAttribute](/powershell/module/microsoft.powershell.core/about/about_Functions_CmdletBindingAttribute)
23-
- [Everything you wanted to know about ShouldProcess](/powershell/scripting/learn/deep-dives/everything-about-shouldprocess)
21+
- [about_Functions_Advanced_Methods](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_functions_advanced_methods)
22+
- [about_Functions_CmdletBindingAttribute](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_Functions_CmdletBindingAttribute)
23+
- [Everything you wanted to know about ShouldProcess](https://learn.microsoft.com/powershell/scripting/learn/deep-dives/everything-about-shouldprocess)
2424

2525
## How
2626

@@ -66,5 +66,10 @@ function Set-File
6666
{
6767
$Content | Out-File -FilePath $Path
6868
}
69+
else
70+
{
71+
# Code that should be processed if doing a WhatIf operation
72+
# Must NOT change anything outside of the function / script
73+
}
6974
}
7075
```

docs/Rules/UseApprovedVerbs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ All cmdlets must used approved verbs.
1616
Approved verbs can be found by running the command `Get-Verb`.
1717

1818
Additional documentation on approved verbs can be found in the microsoft docs page
19-
[Approved Verbs for PowerShell Commands](https://docs.microsoft.com/powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands).
19+
[Approved Verbs for PowerShell Commands](https://learn.microsoft.com/powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands).
2020
Some unapproved verbs are documented on the approved verbs page and point to approved alternatives.
2121
Try searching for the verb you used to find its approved form. For example, searching for `Read`,
2222
`Open`, or `Search` leads you to `Get`.

0 commit comments

Comments
 (0)