Skip to content

Commit

Permalink
(MicrosoftDocsGH-8665) Standardize "See also" section of about_* do…
Browse files Browse the repository at this point in the history
…cuments for 5.1 (MicrosoftDocs#8666)

* (MicrosoftDocsGH-8665) Standardize "See also" for 5.1

* fix broken link in About.md

Co-authored-by: Sean Wheeler <sean.wheeler@microsoft.com>
  • Loading branch information
michaeltlombardi and sdwheeler authored Mar 18, 2022
1 parent 0707d26 commit 183527a
Show file tree
Hide file tree
Showing 134 changed files with 648 additions and 1,140 deletions.
5 changes: 1 addition & 4 deletions reference/5.1/Microsoft.PowerShell.Core/About/About.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description: About topics cover a ranges of concepts about PowerShell.
Help Version: 6.0
Locale: en-US
ms.date: 10/22/2021
ms.date: 03/18/2022
title: About topics
---
# About topics
Expand Down Expand Up @@ -73,9 +73,6 @@ Provides a brief introduction to the PowerShell Desired State Configuration (DSC
### [about_Do](about_Do.md)
Runs a statement list one or more times, subject to a While or Until condition.

### [about_dsclogresource](about_dsclogresource.md)
Provides a brief introduction to the PowerShell Desired State Configuration (DSC) Log Resource.

### [about_Enum](about_Enum.md)
The `enum` statement is used to declare an enumeration. An enumeration is a distinct type that consists of a set of named labels called the enumerator list.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,5 @@ Get-Help Get-ChildItem -Path alias:

## See also

[about_Aliases](../About/about_Aliases.md)

[about_Providers](../About/about_Providers.md)
- [about_Aliases](about_Aliases.md)
- [about_Providers](about_Providers.md)
14 changes: 7 additions & 7 deletions reference/5.1/Microsoft.PowerShell.Core/About/about_Aliases.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,16 +256,16 @@ Get-Help Alias

## See also

- [New-Alias](xref:Microsoft.PowerShell.Utility.New-Alias)
- [Get-Alias](xref:Microsoft.PowerShell.Utility.Get-Alias)
- [Set-Alias](xref:Microsoft.PowerShell.Utility.Set-Alias)
- [about_Functions](about_Functions.md)
- [about_Profiles](about_Profiles.md)
- [about_Providers](about_Providers.md)
- [Export-Alias](xref:Microsoft.PowerShell.Utility.Export-Alias)
- [Get-Alias](xref:Microsoft.PowerShell.Utility.Get-Alias)
- [Import-Alias](xref:Microsoft.PowerShell.Utility.Import-Alias)
- [Get-PSProvider](xref:Microsoft.PowerShell.Management.Get-PSProvider)
- [New-Alias](xref:Microsoft.PowerShell.Utility.New-Alias)
- [Set-Alias](xref:Microsoft.PowerShell.Utility.Set-Alias)
- [Get-PSDrive](xref:Microsoft.PowerShell.Management.Get-PSDrive)
- [about_functions](about_functions.md)
- [about_profiles](about_profiles.md)
- [about_providers](about_providers.md)
- [Get-PSProvider](xref:Microsoft.PowerShell.Management.Get-PSProvider)

<!-- External links -->
[aliasinfo]: /dotnet/api/system.management.automation.aliasinfo
Original file line number Diff line number Diff line change
Expand Up @@ -527,11 +527,11 @@ right operand determine how many bits of the left operand are shifted.

## See also

- [about_arrays](about_Arrays.md)
- [about_assignment_operators](about_Assignment_Operators.md)
- [about_comparison_operators](about_Comparison_Operators.md)
- [about_hash_tables](about_Hash_Tables.md)
- [about_operators](about_Operators.md)
- [about_variables](about_Variables.md)
- [about_Arrays](about_Arrays.md)
- [about_Hash_Tables](about_Hash_Tables.md)
- [about_Operators](about_Operators.md)
- [about_Assignment_Operators](about_Assignment_Operators.md)
- [about_Comparison_Operators](about_Comparison_Operators.md)
- [about_Variables](about_Variables.md)
- [Get-Date](xref:Microsoft.PowerShell.Utility.Get-Date)
- [New-TimeSpan](xref:Microsoft.PowerShell.Utility.New-TimeSpan)
6 changes: 3 additions & 3 deletions reference/5.1/Microsoft.PowerShell.Core/About/about_Arrays.md
Original file line number Diff line number Diff line change
Expand Up @@ -1017,10 +1017,10 @@ LastWriteTimeUtc Property datetime LastWriteTimeUtc {get;set;}
## See also

- [about_Assignment_Operators](about_Assignment_Operators.md)
- [about_For](about_For.md)
- [about_Foreach](about_Foreach.md)
- [about_Hash_Tables](about_Hash_Tables.md)
- [about_Member-Access_Enumeration](about_Member-Access_Enumeration.md)
- [about_Operators](about_Operators.md)
- [about_For](about_For.md)
- [about_Foreach](about_Foreach.md)
- [about_Assignment_Operators](about_Assignment_Operators.md)
- [about_While](about_While.md)
Original file line number Diff line number Diff line change
Expand Up @@ -859,14 +859,9 @@ Set-Variable -Name a -Value 1, 2, 3

## See also

[about_Arrays](about_Arrays.md)

[about_Hash_Tables](about_Hash_Tables.md)

[about_Variables](about_Variables.md)

[Clear-Variable](xref:Microsoft.PowerShell.Utility.Clear-Variable)

[Remove-Variable](xref:Microsoft.PowerShell.Utility.Remove-Variable)

[Set-Variable](xref:Microsoft.PowerShell.Utility.Set-Variable)
- [about_Arrays](about_Arrays.md)
- [about_Hash_Tables](about_Hash_Tables.md)
- [about_Variables](about_Variables.md)
- [Clear-Variable](xref:Microsoft.PowerShell.Utility.Clear-Variable)
- [Remove-Variable](xref:Microsoft.PowerShell.Utility.Remove-Variable)
- [Set-Variable](xref:Microsoft.PowerShell.Utility.Set-Variable)
Original file line number Diff line number Diff line change
Expand Up @@ -940,22 +940,13 @@ Default (Current): End

## See also

[about_Functions](about_Functions.md)

[about_Functions_Advanced](about_Functions_Advanced.md)

[about_Functions_Advanced_Methods](about_Functions_Advanced_Methods.md)

[about_Functions_Advanced_Parameters](about_Functions_Advanced_Parameters.md)

[about_Functions_OutputTypeAttribute](about_Functions_OutputTypeAttribute.md)

[about_Functions_CmdletBindingAttribute](about_Functions_CmdletBindingAttribute.md)

[about_Hash_Tables](about_Hash_Tables.md)

[about_Preference_Variables](about_Preference_Variables.md)

[about_Splatting](about_Splatting.md)

[about_Variables](about_Variables.md)
- [about_Functions](about_Functions.md)
- [about_Functions_Advanced](about_Functions_Advanced.md)
- [about_Functions_Advanced_Methods](about_Functions_Advanced_Methods.md)
- [about_Functions_Advanced_Parameters](about_Functions_Advanced_Parameters.md)
- [about_Functions_OutputTypeAttribute](about_Functions_OutputTypeAttribute.md)
- [about_Functions_CmdletBindingAttribute](about_Functions_CmdletBindingAttribute.md)
- [about_Hash_Tables](about_Hash_Tables.md)
- [about_Preference_Variables](about_Preference_Variables.md)
- [about_Splatting](about_Splatting.md)
- [about_Variables](about_Variables.md)
26 changes: 9 additions & 17 deletions reference/5.1/Microsoft.PowerShell.Core/About/about_Break.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,20 +224,12 @@ runspace.

## See also

[about_Comparison_Operators](about_Comparison_Operators.md)

[about_Continue](about_Continue.md)

[about_For](about_For.md)

[about_Foreach](about_Foreach.md)

[about_Switch](about_Switch.md)

[about_Throw](about_Throw.md)

[about_Trap](about_Trap.md)

[about_Try_Catch_Finally](about_Try_Catch_Finally.md)

[about_While](about_While.md)
- [about_Comparison_Operators](about_Comparison_Operators.md)
- [about_Continue](about_Continue.md)
- [about_For](about_For.md)
- [about_Foreach](about_Foreach.md)
- [about_Switch](about_Switch.md)
- [about_Throw](about_Throw.md)
- [about_Trap](about_Trap.md)
- [about_Try_Catch_Finally](about_Try_Catch_Finally.md)
- [about_While](about_While.md)
Original file line number Diff line number Diff line change
Expand Up @@ -470,26 +470,15 @@ Date Salesperson UnitsSold

## See also

[about_Hash_Tables](about_hash_tables.md)

[Compare-Object](xref:Microsoft.PowerShell.Utility.Compare-Object)

[ConvertTo-Html](xref:Microsoft.PowerShell.Utility.ConvertTo-Html)

[Format-Custom](xref:Microsoft.PowerShell.Utility.Format-Custom)

[Format-List](xref:Microsoft.PowerShell.Utility.Format-List)

[Format-Table](xref:Microsoft.PowerShell.Utility.Format-Table)

[Format-Wide](xref:Microsoft.PowerShell.Utility.Format-Wide)

[Group-Object](xref:Microsoft.PowerShell.Utility.Group-Object)

[Measure-Object](xref:Microsoft.PowerShell.Utility.Measure-Object)

[Select-Object](xref:Microsoft.PowerShell.Utility.Select-Object)

[Sort-Object](xref:Microsoft.PowerShell.Utility.Sort-Object)

[Format types in .NET](/dotnet/standard/base-types/formatting-types)
- [about_Hash_Tables](about_hash_tables.md)
- [ConvertTo-Html](xref:Microsoft.PowerShell.Utility.ConvertTo-Html)
- [Format-Custom](xref:Microsoft.PowerShell.Utility.Format-Custom)
- [Format-List](xref:Microsoft.PowerShell.Utility.Format-List)
- [Format-Table](xref:Microsoft.PowerShell.Utility.Format-Table)
- [Format-Wide](xref:Microsoft.PowerShell.Utility.Format-Wide)
- [Compare-Object](xref:Microsoft.PowerShell.Utility.Compare-Object)
- [Group-Object](xref:Microsoft.PowerShell.Utility.Group-Object)
- [Measure-Object](xref:Microsoft.PowerShell.Utility.Measure-Object)
- [Select-Object](xref:Microsoft.PowerShell.Utility.Select-Object)
- [Sort-Object](xref:Microsoft.PowerShell.Utility.Sort-Object)
- [Format types in .NET](/dotnet/standard/base-types/formatting-types)
Original file line number Diff line number Diff line change
Expand Up @@ -217,10 +217,10 @@ the output redirection operators and PowerShell cmdlets use to save to files.

## See also

- [Introduction to character encoding in .NET](/dotnet/standard/base-types/character-encoding-introduction)
- [about_Preference_Variables](about_Preference_Variables.md)
- [Byte order mark](https://wikipedia.org/wiki/Byte_order_mark)
- [Code Pages - Win32 apps](/windows/win32/intl/code-pages)
- [The Unicode Standard](https://www.unicode.org/standard/standard.html)
- [Encoding.CodePage](/dotnet/api/system.text.encoding.codepage)
- [Introduction to character encoding in .NET](/dotnet/standard/base-types/character-encoding-introduction)
- [The Unicode Standard](https://www.unicode.org/standard/standard.html)
- [UTF-16LE](https://wikipedia.org/wiki/UTF-16)
- [Byte order mark](https://wikipedia.org/wiki/Byte_order_mark)
- [about_Preference_Variables](about_Preference_Variables.md)
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,5 @@ understand the **ThrottleLimit**.

## See also

[New-CimSession](xref:CimCmdlets.New-CimSession)

[about_PSSessions](about_PSSessions.md)
- [about_PSSessions](about_PSSessions.md)
- [New-CimSession](xref:CimCmdlets.New-CimSession)
Original file line number Diff line number Diff line change
Expand Up @@ -873,8 +873,8 @@ For more information about the `[ref]` type, see

## See also

- [About_hidden](About_hidden.md)
- [about_Enum](about_Enum.md)
- [About_Hidden](About_Hidden.md)
- [about_Language_Keywords](about_language_keywords.md)
- [about_Methods](about_methods.md)
- [about_Using](about_using.md)
Original file line number Diff line number Diff line change
Expand Up @@ -342,9 +342,9 @@ you must add the extension to the `$env:PATHEXT` environment variable.

## See also

- [about_Path_Syntax](about_Path_Syntax.md)
- [about_Aliases](about_Aliases.md)
- [about_Functions](about_Functions.md)
- [about_Path_Syntax](about_Path_Syntax.md)
- [Alias-Provider](../../Microsoft.PowerShell.Core/About/about_Alias_Provider.md)
- [Function-Provider](../../Microsoft.PowerShell.Core/About/about_Function_Provider.md)
- [Get-Command](xref:Microsoft.PowerShell.Core.Get-Command)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -866,10 +866,7 @@ Displays information about PowerShell cmdlets and concepts.

## See also

[about_Functions](about_Functions.md)

[about_Functions_Advanced_Parameters](about_Functions_Advanced_Parameters.md)

[about_Scripts](about_Scripts.md)

[How to Write Cmdlet Help](https://go.microsoft.com/fwlink/?LinkID=123415)
- [about_Functions](about_Functions.md)
- [about_Functions_Advanced_Parameters](about_Functions_Advanced_Parameters.md)
- [about_Scripts](about_Scripts.md)
- [How to Write Cmdlet Help](https://go.microsoft.com/fwlink/?LinkID=123415)
Original file line number Diff line number Diff line change
Expand Up @@ -743,12 +743,8 @@ about_Common_Parameters
## See also
[about_Preference_Variables](about_Preference_Variables.md)
[Write-Debug](xref:Microsoft.PowerShell.Utility.Write-Debug)
[Write-Warning](xref:Microsoft.PowerShell.Utility.Write-Warning)
[Write-Error](xref:Microsoft.PowerShell.Utility.Write-Error)
[Write-Verbose](xref:Microsoft.PowerShell.Utility.Write-Verbose)
- [about_Preference_Variables](about_Preference_Variables.md)
- [Write-Debug](xref:Microsoft.PowerShell.Utility.Write-Debug)
- [Write-Error](xref:Microsoft.PowerShell.Utility.Write-Error)
- [Write-Verbose](xref:Microsoft.PowerShell.Utility.Write-Verbose)
- [Write-Warning](xref:Microsoft.PowerShell.Utility.Write-Warning)
Original file line number Diff line number Diff line change
Expand Up @@ -679,13 +679,13 @@ $a -isnot $b.GetType() # Output: True

## See also

- [about_Booleans](about_Booleans.md)
- [about_Operators](about_Operators.md)
- [about_Regular_Expressions](about_Regular_Expressions.md)
- [about_Wildcards](about_Wildcards.md)
- [Compare-Object](xref:Microsoft.PowerShell.Utility.Compare-Object)
- [Foreach-Object](xref:Microsoft.PowerShell.Core.ForEach-Object)
- [Where-Object](xref:Microsoft.PowerShell.Core.Where-Object)
- [about_Booleans](about_Booleans.md)

[1]: /dotnet/api/system.icomparable
[2]: /dotnet/api/system.iequatable-1
Expand Down
17 changes: 6 additions & 11 deletions reference/5.1/Microsoft.PowerShell.Core/About/about_Continue.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,14 +130,9 @@ not only exits the pipeline, it potentially terminates the entire runspace.

## See also

[about_Break](about_Break.md)

[about_For](about_For.md)

[about_Comparison_Operators](about_Comparison_Operators.md)

[about_Throw](about_Throw.md)

[about_Trap](about_Trap.md)

[about_Try_Catch_Finally](about_Try_Catch_Finally.md)
- [about_Break](about_Break.md)
- [about_Comparison_Operators](about_Comparison_Operators.md)
- [about_For](about_For.md)
- [about_Throw](about_Throw.md)
- [about_Trap](about_Trap.md)
- [about_Try_Catch_Finally](about_Try_Catch_Finally.md)
Original file line number Diff line number Diff line change
Expand Up @@ -91,4 +91,4 @@ For more information about a cmdlet, type `get-help <cmdlet-name>`.

## See also

[about_Providers](about_Providers.md)
- [about_Providers](about_Providers.md)
Original file line number Diff line number Diff line change
Expand Up @@ -200,20 +200,12 @@ DATA -supportedCommand Format-XML {

## See also

[about_Automatic_Variables](about_Automatic_Variables.md)

[about_Comparison_Operators](about_Comparison_Operators.md)

[about_Hash_Tables](about_Hash_Tables.md)

[about_If](about_If.md)

[about_Operators](about_Operators.md)

[about_Quoting_Rules](about_Quoting_Rules.md)

[about_Script_Internationalization](about_Script_Internationalization.md)

[ConvertFrom-StringData](xref:Microsoft.PowerShell.Utility.ConvertFrom-StringData)

[Import-LocalizedData](xref:Microsoft.PowerShell.Utility.Import-LocalizedData)
- [about_Automatic_Variables](about_Automatic_Variables.md)
- [about_Comparison_Operators](about_Comparison_Operators.md)
- [about_Hash_Tables](about_Hash_Tables.md)
- [about_If](about_If.md)
- [about_Operators](about_Operators.md)
- [about_Quoting_Rules](about_Quoting_Rules.md)
- [about_Script_Internationalization](about_Script_Internationalization.md)
- [ConvertFrom-StringData](xref:Microsoft.PowerShell.Utility.ConvertFrom-StringData)
- [Import-LocalizedData](xref:Microsoft.PowerShell.Utility.Import-LocalizedData)
Original file line number Diff line number Diff line change
Expand Up @@ -853,8 +853,8 @@ features that you can use to debug scripts and functions.
- [Disable-PSBreakpoint](xref:Microsoft.PowerShell.Utility.Disable-PSBreakpoint)
- [Enable-PSBreakpoint](xref:Microsoft.PowerShell.Utility.Enable-PSBreakpoint)
- [Get-PSBreakpoint](xref:Microsoft.PowerShell.Utility.Get-PSBreakpoint)
- [Get-PSCallStack](xref:Microsoft.PowerShell.Utility.Get-PSCallStack)
- [Remove-PSBreakpoint](xref:Microsoft.PowerShell.Utility.Remove-PSBreakpoint)
- [Set-PSBreakpoint](xref:Microsoft.PowerShell.Utility.Set-PSBreakpoint)
- [Get-PSCallStack](xref:Microsoft.PowerShell.Utility.Get-PSCallStack)
- [Write-Debug](xref:Microsoft.PowerShell.Utility.Write-Debug)
- [Write-Verbose](xref:Microsoft.PowerShell.Utility.Write-Verbose)
Original file line number Diff line number Diff line change
Expand Up @@ -170,8 +170,6 @@ to browse and learn about available DSC resources.

## See also

[PowerShell Desired State Configuration Overview](/powershell/scripting/dsc/overview/)

[Built-In PowerShell Desired State Configuration Resources](/powershell/scripting/dsc/resources/resources)

[Build Custom PowerShell Desired State Configuration Resources](/powershell/scripting/dsc/resources/authoringResource)
- [PowerShell Desired State Configuration Overview](/powershell/scripting/dsc/overview/)
- [Built-In PowerShell Desired State Configuration Resources](/powershell/scripting/dsc/resources/resources)
- [Build Custom PowerShell Desired State Configuration Resources](/powershell/scripting/dsc/resources/authoringResource)
8 changes: 4 additions & 4 deletions reference/5.1/Microsoft.PowerShell.Core/About/about_Do.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,10 +85,10 @@ while (++$a -lt 10)

## See also

- [about_While](about_While.md)
- [about_Booleans](about_Booleans.md)
- [about_Break](about_Break.md)
- [about_Continue](about_Continue.md)
- [about_Operators](about_Operators.md)
- [about_Assignment_Operators](about_Assignment_Operators.md)
- [about_Comparison_Operators](about_Comparison_Operators.md)
- [about_Break](about_Break.md)
- [about_Continue](about_Continue.md)
- [about_Booleans](about_Booleans.md)
- [about_While](about_While.md)
Loading

0 comments on commit 183527a

Please sign in to comment.