Add metadata to docs (PowerShell#1731)

kisakifaca · Oct 19, 2021 · 0be5a01 · 0be5a01
1 parent 71f44d6
commit 0be5a01
Show file tree

Hide file tree

Showing 71 changed files with 530 additions and 62 deletions.
diff --git a/docs/Cmdlets/Get-ScriptAnalyzerRule.md b/docs/Cmdlets/Get-ScriptAnalyzerRule.md
@@ -1,6 +1,7 @@
----
+---
 external help file: Microsoft.Windows.PowerShell.ScriptAnalyzer.dll-Help.xml
 Module Name: PSScriptAnalyzer
+ms.custom: PSSA v1.20.0
 ms.date: 10/07/2021
 online version: https://docs.microsoft.com/powershell/module/psscriptanalyzer/get-scriptanalyzerrule?view=ps-modules&wt.mc_id=ps-gethelp
 schema: 2.0.0

diff --git a/docs/Cmdlets/Invoke-Formatter.md b/docs/Cmdlets/Invoke-Formatter.md
@@ -1,6 +1,7 @@
----
+---
 external help file: Microsoft.Windows.PowerShell.ScriptAnalyzer.dll-Help.xml
 Module Name: PSScriptAnalyzer
+ms.custom: PSSA v1.20.0
 ms.date: 10/07/2021
 online version: https://docs.microsoft.com/powershell/module/psscriptanalyzer/invoke-formatter?view=ps-modules&wt.mc_id=ps-gethelp
 schema: 2.0.0

diff --git a/docs/Cmdlets/Invoke-ScriptAnalyzer.md b/docs/Cmdlets/Invoke-ScriptAnalyzer.md
@@ -1,6 +1,7 @@
----
+---
 external help file: Microsoft.Windows.PowerShell.ScriptAnalyzer.dll-Help.xml
 Module Name: PSScriptAnalyzer
+ms.custom: PSSA v1.20.0
 ms.date: 10/07/2021
 online version: https://docs.microsoft.com/powershell/module/psscriptanalyzer/invoke-scriptanalyzer?view=ps-modules&wt.mc_id=ps-gethelp
 schema: 2.0.0

diff --git a/docs/Cmdlets/PSScriptAnalyzer.md b/docs/Cmdlets/PSScriptAnalyzer.md
@@ -1,10 +1,11 @@
----
-Module Name: PSScriptAnalyzer
-Module Guid: d6245802-193d-4068-a631-8863a4342a18
-ms.date: 10/07/2021
-Download Help Link:  https://aka.ms/ps-modules-help
+---
+Download Help Link: https://aka.ms/ps-modules-help
 Help Version: 1.20.0
 Locale: en-US
+Module Guid: d6245802-193d-4068-a631-8863a4342a18
+Module Name: PSScriptAnalyzer
+ms.custom: PSSA v1.20.0
+ms.date: 10/07/2021
 ---
 
 # PSScriptAnalyzer Module

diff --git a/docs/Rules/AlignAssignmentStatement.md b/docs/Rules/AlignAssignmentStatement.md
@@ -1,4 +1,11 @@
-# AlignAssignmentStatement
+---
+description: Align assignment statement
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AlignAssignmentStatement
+---
+# AlignAssignmentStatement
 
 **Severity Level: Warning**
 

diff --git a/docs/Rules/AvoidAssignmentToAutomaticVariable.md b/docs/Rules/AvoidAssignmentToAutomaticVariable.md
@@ -1,3 +1,10 @@
+---
+description: Changing automatic variables might have undesired side effects
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidAssignmentToAutomaticVariable
+---
 # AvoidAssignmentToAutomaticVariable
 
 **Severity Level: Warning**

diff --git a/docs/Rules/AvoidDefaultValueForMandatoryParameter.md b/docs/Rules/AvoidDefaultValueForMandatoryParameter.md
@@ -1,3 +1,10 @@
+---
+description: Avoid Default Value For Mandatory Parameter
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidDefaultValueForMandatoryParameter
+---
 # AvoidDefaultValueForMandatoryParameter
 
 **Severity Level: Warning**

diff --git a/docs/Rules/AvoidDefaultValueSwitchParameter.md b/docs/Rules/AvoidDefaultValueSwitchParameter.md
@@ -1,3 +1,10 @@
+---
+description: Switch Parameters Should Not Default To True
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidDefaultValueSwitchParameter
+---
 # AvoidDefaultValueSwitchParameter
 
 **Severity Level: Warning**

diff --git a/docs/Rules/AvoidGlobalAliases.md b/docs/Rules/AvoidGlobalAliases.md
@@ -1,3 +1,10 @@
+---
+description: Avoid global aliases.
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidGlobalAliases
+---
 # AvoidGlobalAliases
 
 **Severity Level: Warning**

diff --git a/docs/Rules/AvoidGlobalFunctions.md b/docs/Rules/AvoidGlobalFunctions.md
@@ -1,3 +1,10 @@
+---
+description: Avoid global functions and aliases
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidGlobalFunctions
+---
 # AvoidGlobalFunctions
 
 **Severity Level: Warning**

diff --git a/docs/Rules/AvoidGlobalVars.md b/docs/Rules/AvoidGlobalVars.md
@@ -1,3 +1,10 @@
+---
+description: No Global Variables
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidGlobalVars
+---
 # AvoidGlobalVars
 
 **Severity Level: Warning**

diff --git a/docs/Rules/AvoidInvokingEmptyMembers.md b/docs/Rules/AvoidInvokingEmptyMembers.md
@@ -1,3 +1,10 @@
+---
+description: Avoid Invoking Empty Members
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidInvokingEmptyMembers
+---
 # AvoidInvokingEmptyMembers
 
 **Severity Level: Warning**

diff --git a/docs/Rules/AvoidLongLines.md b/docs/Rules/AvoidLongLines.md
@@ -1,3 +1,10 @@
+---
+description: Avoid long lines
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidLongLines
+---
 # AvoidLongLines
 
 **Severity Level: Warning**

diff --git a/docs/Rules/AvoidMultipleTypeAttributes.md b/docs/Rules/AvoidMultipleTypeAttributes.md
@@ -1,3 +1,10 @@
+---
+description: Avoid multiple type specifiers on parameters.
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidMultipleTypeAttributes
+---
 # AvoidMultipleTypeAttributes
 
 **Severity Level: Warning**

diff --git a/docs/Rules/AvoidNullOrEmptyHelpMessageAttribute.md b/docs/Rules/AvoidNullOrEmptyHelpMessageAttribute.md
@@ -1,3 +1,10 @@
+---
+description: Avoid using null or empty HelpMessage parameter attribute.
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidNullOrEmptyHelpMessageAttribute
+---
 # AvoidNullOrEmptyHelpMessageAttribute
 
 **Severity Level: Warning**

diff --git a/docs/Rules/AvoidOverwritingBuiltInCmdlets.md b/docs/Rules/AvoidOverwritingBuiltInCmdlets.md
@@ -1,3 +1,10 @@
+---
+description: Avoid overwriting built in cmdlets
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidOverwritingBuiltInCmdlets
+---
 # AvoidOverwritingBuiltInCmdlets
 
 **Severity Level: Warning**

diff --git a/docs/Rules/AvoidShouldContinueWithoutForce.md b/docs/Rules/AvoidShouldContinueWithoutForce.md
@@ -1,3 +1,10 @@
+---
+description: Avoid Using ShouldContinue Without Boolean Force Parameter
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidShouldContinueWithoutForce
+---
 # AvoidShouldContinueWithoutForce
 
 **Severity Level: Warning**

diff --git a/docs/Rules/AvoidTrailingWhitespace.md b/docs/Rules/AvoidTrailingWhitespace.md
@@ -1,3 +1,10 @@
+---
+description: Avoid trailing whitespace
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidTrailingWhitespace
+---
 # AvoidTrailingWhitespace
 
 **Severity Level: Information**

diff --git a/docs/Rules/AvoidUsingCmdletAliases.md b/docs/Rules/AvoidUsingCmdletAliases.md
@@ -1,3 +1,10 @@
+---
+description: Avoid Using Cmdlet Aliases or omitting the 'Get-' prefix.
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidUsingCmdletAliases
+---
 # AvoidUsingCmdletAliases
 
 **Severity Level: Warning**

diff --git a/docs/Rules/AvoidUsingComputerNameHardcoded.md b/docs/Rules/AvoidUsingComputerNameHardcoded.md
@@ -1,3 +1,10 @@
+---
+description: Avoid Using ComputerName Hardcoded
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidUsingComputerNameHardcoded
+---
 # AvoidUsingComputerNameHardcoded
 
 **Severity Level: Error**
@@ -11,7 +18,7 @@ The names of computers should never be hard coded as this will expose sensitive
 
 Remove hard coded computer names.
 
-## Example
+## Example 1
 
 ### Wrong
 
@@ -31,7 +38,7 @@ Function Invoke-MyCommand ($ComputerName)
 }
 ```
 
-## Example
+## Example 2
 
 ### Wrong
 

diff --git a/docs/Rules/AvoidUsingConvertToSecureStringWithPlainText.md b/docs/Rules/AvoidUsingConvertToSecureStringWithPlainText.md
@@ -1,3 +1,10 @@
+---
+description: Avoid Using SecureString With Plain Text
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidUsingConvertToSecureStringWithPlainText
+---
 # AvoidUsingConvertToSecureStringWithPlainText
 
 **Severity Level: Error**

diff --git a/docs/Rules/AvoidUsingDeprecatedManifestFields.md b/docs/Rules/AvoidUsingDeprecatedManifestFields.md
@@ -1,3 +1,10 @@
+---
+description: Avoid Using Deprecated Manifest Fields
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidUsingDeprecatedManifestFields
+---
 # AvoidUsingDeprecatedManifestFields
 
 **Severity Level: Warning**

diff --git a/docs/Rules/AvoidUsingDoubleQuotesForConstantString.md b/docs/Rules/AvoidUsingDoubleQuotesForConstantString.md
@@ -1,3 +1,10 @@
+---
+description: Avoid using double quotes if the string is constant.
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidUsingDoubleQuotesForConstantString
+---
 # AvoidUsingDoubleQuotesForConstantString
 
 **Severity Level: Information**

diff --git a/docs/Rules/AvoidUsingEmptyCatchBlock.md b/docs/Rules/AvoidUsingEmptyCatchBlock.md
@@ -1,3 +1,10 @@
+---
+description: Avoid Using Empty Catch Block
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidUsingEmptyCatchBlock
+---
 # AvoidUsingEmptyCatchBlock
 
 **Severity Level: Warning**

diff --git a/docs/Rules/AvoidUsingInvokeExpression.md b/docs/Rules/AvoidUsingInvokeExpression.md
@@ -1,3 +1,10 @@
+---
+description: Avoid Using Invoke-Expression
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidUsingInvokeExpression
+---
 # AvoidUsingInvokeExpression
 
 **Severity Level: Warning**

diff --git a/docs/Rules/AvoidUsingPlainTextForPassword.md b/docs/Rules/AvoidUsingPlainTextForPassword.md
@@ -1,3 +1,10 @@
+---
+description: Avoid Using Plain Text For Password Parameter
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidUsingPlainTextForPassword
+---
 # AvoidUsingPlainTextForPassword
 
 **Severity Level: Warning**

diff --git a/docs/Rules/AvoidUsingPositionalParameters.md b/docs/Rules/AvoidUsingPositionalParameters.md
@@ -1,3 +1,10 @@
+---
+description: Avoid Using Positional Parameters
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidUsingPositionalParameters
+---
 # AvoidUsingPositionalParameters
 
 ** Severity Level: Information **

diff --git a/docs/Rules/AvoidUsingUsernameAndPasswordParams.md b/docs/Rules/AvoidUsingUsernameAndPasswordParams.md
@@ -1,3 +1,10 @@
+---
+description: Avoid Using Username and Password Parameters
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidUsingUsernameAndPasswordParams
+---
 # AvoidUsingUsernameAndPasswordParams
 
 **Severity Level: Error**

diff --git a/docs/Rules/AvoidUsingWMICmdlet.md b/docs/Rules/AvoidUsingWMICmdlet.md
@@ -1,3 +1,10 @@
+---
+description: Avoid Using Get-WMIObject, Remove-WMIObject, Invoke-WmiMethod, Register-WmiEvent, Set-WmiInstance
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidUsingWMICmdlet
+---
 # AvoidUsingWMICmdlet
 
 **Severity Level: Warning**

diff --git a/docs/Rules/AvoidUsingWriteHost.md b/docs/Rules/AvoidUsingWriteHost.md
@@ -1,3 +1,10 @@
+---
+description: Avoid Using Write-Host
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: AvoidUsingWriteHost
+---
 # AvoidUsingWriteHost
 
 **Severity Level: Warning**

diff --git a/docs/Rules/DSCDscExamplesPresent.md b/docs/Rules/DSCDscExamplesPresent.md
@@ -1,3 +1,10 @@
+---
+description: DSC examples are present
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: DSCDscExamplesPresent
+---
 # DscExamplesPresent
 
 **Severity Level: Information**

diff --git a/docs/Rules/DSCDscTestsPresent.md b/docs/Rules/DSCDscTestsPresent.md
@@ -1,3 +1,10 @@
+---
+description: Dsc tests are present
+ms.custom: PSSA v1.20.0
+ms.date: 10/18/2021
+ms.topic: reference
+title: DSCDscTestsPresent
+---
 # DscTestsPresent
 
 **Severity Level: Information**