Backport MSDocs changes

[bergmeister]

PR Summary

• Where references to files in MSDoccs were present (e.g. in UseShouldProcessForStateChangingFunctions), replaced with the live URLs.
• Did not port back TODO block of AvoidAssignmentToAutomaticVariable.md from https://github.com/MicrosoftDocs/PowerShell-Docs-Modules/pull/241/files#diff-1db3dc2f98da1fa58e24bac28ea9f14f507c78d8299349aa0196f01f9479b6f5

Backported PRs:

• https://github.com/MicrosoftDocs/PowerShell-Docs-Modules/pull/281/files
• MicrosoftDocs/PowerShell-Docs-Modules@ff80de6
• https://github.com/MicrosoftDocs/PowerShell-Docs-Modules/pull/275/files
• Explain the proper use of a SwitchParameter MicrosoftDocs/PowerShell-Docs-Modules#278
• https://github.com/MicrosoftDocs/PowerShell-Docs-Modules/pull/235/files
• https://github.com/MicrosoftDocs/PowerShell-Docs-Modules/pull/276/files
• Replaced duplicate link and improved examples for $null MicrosoftDocs/PowerShell-Docs-Modules#273
• Provide more guidance for file encoding MicrosoftDocs/PowerShell-Docs-Modules#285
• MicrosoftDocs/PowerShell-Docs-Modules@6ca872b#diff-b3e50d455fe1b464a6fec38ac616cbde4a412766a05a606c1ae55be90ccb63a3
• Describe the purpose of ShouldProcess MicrosoftDocs/PowerShell-Docs-Modules#277

PR Checklist

• PR has a meaningful title
  • Use the present tense and imperative mood when describing your changes
• Summarized changes
• Change is not breaking
• Make sure all .cs, .ps1 and .psm1 files have the correct copyright header
• Make sure you've added a new test if existing tests do not effectively test the code changed and/or updated documentation
• This PR is ready to merge and is not Work in Progress.
  • If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready.

[sdwheeler]

@bergmeister I had changes in flight for this already and my changes had a few things you missed. I added my changes to this PR.

[sdwheeler]

LGTM

[bergmeister]

In my original PR I left this out because this comment relates more to work in MSDocs. Maybe a GitHub issue is a better place for it than a comment?

[sdwheeler]

We should add this information in both repos before release. I couldn't figure out how to configure this. Can you provide an example?

[bergmeister]

Suppression is not different that any other rule. For example [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidAssignmentToAutomaticVariable', '')] suppresses the rule and [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidAssignmentToAutomaticVariable', 'PID')] makes the suppression specific to assignment to $PID automatic variable

[sdwheeler]

Can you only do this in code? Other rules can be configured using JSON. For example: https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/usesingularnouns#configuration

[bergmeister]

Suppression is only possible via annotating code with this attribute unless one decided to not run rule at all via PSSA settings but I wouldn't call that suppression: https://learn.microsoft.com/en-us/powershell/utility-modules/psscriptanalyzer/using-scriptanalyzer?view=ps-modules#suppressing-rules
What you reference is rule configuration as part of PSSA settings, which is not JSON, it's PowerShell's hashtable format: https://learn.microsoft.com/en-us/powershell/utility-modules/psscriptanalyzer/using-scriptanalyzer?view=ps-modules#settings-support-in-scriptanalyzer

[andyleejordan]

@sdwheeler @bergmeister this seems to have removed some information from #1704 for docs/Rules/UseCorrectCasing.md specifically around keywords and operators. Was that intentional?

[sdwheeler]

I have had so many issues with the docs branches. I had a draft update for UserCorrectCasing.md that has gone missing. Let me see if I can find it and update again.