Fix broken links to old .md files, set correct root directory for Get-RuleDocumentationPath function by fabge · Pull Request #1730 · PowerShell/PSScriptAnalyzer · GitHub

PR Summary

There were still links to the old "RuleDocumentation" folder and some files were renamed.
The root directory if the Get-RuleDocumentationPath function was also set to the "Rules" folder

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.

…-RuleDocumentationPath function

All CLA requirements met.

Great catch! One more extension to fix (I think).

The new links here will link to the source code. Instead they should link to the rule documentation, which looks like it now lives under https://github.com/PowerShell/PSScriptAnalyzer/tree/master/docs/Rules

Rob is right, the .cs are transformed into .md into the confusingly similarly named docs/Rules folder (instead of just Rules) found here: https://github.com/PowerShell/PSScriptAnalyzer/tree/master/docs/Rules

So, the links are still broken as-is, but the fix is different. Keep the .md extension, but point to docs/Rules/ instead of RuleDocumentation/ (or Rules/ as in this first iteration).

the confusingly similarly named docs/Rules folder

It used to be RulesDocumentation but #1724 changed this so all documentation is under one folder.

Thanks for the feedback. I pushed a new commit, changing the filepaths to the Markdown files under docs/Rules.
I couldn't find the corresponding Markdown file for the https://github.com/PowerShell/PSScriptAnalyzer/blob/master/Rules/AvoidAlias.cs rule. Any pointers if this is missing or does not exist?

Thanks so much!

Suggested change

      
            - Empty catch block should not be used [AvoidEmptyCatchBlock](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Rules/AvoidUsingEmptyCatchBlock.md)
          
            - Empty catch block should not be used [AvoidUsingEmptyCatchBlock](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Rules/AvoidUsingEmptyCatchBlock.md)

Suggested change

      
            - Positional parameters should be avoided [AvoidPositionalParameters](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Rules/AvoidUsingPositionalParameters.md)
          
            - Positional parameters should be avoided [AvoidUsingPositionalParameters](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Rules/AvoidUsingPositionalParameters.md)

Suggested change

      
            - Password = 'string' should not be used. (information disclosure) [AvoidUserNameAndPasswordParams](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Rules/AvoidUsingUsernameAndPasswordParams.md)
          
            - Password = 'string' should not be used. (information disclosure) [AvoidUsingUserNameAndPasswordParams](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Rules/AvoidUsingUsernameAndPasswordParams.md)

Suggested change

      
            - Avoid using alias [AvoidAlias](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Rules/AvoidAlias.md) #TODO not found
          
            - Avoid using cmdlet aliases [AvoidUsingCmdletAliases](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Rules/AvoidUsingCmdletAliases.md)

I looked through the Git history and this was renamed in 11a04a9

LGTM, I resolved the merge conflict, please check you are happy with it. Can you give it a final review Sean Wheeler (@sdwheeler) and Andy Jordan (@andschwa) please?

Just a note about this article. This has been migrated to https://docs.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules-recommendations. It is scheduled to be deleted from the source repo in a month.

Guys, can you either merge or reject? I'd like this closed...

Sydney Smith (@SydneyhSmith) and James Truher (@JamesWTruher) we need to triage / merge this!

To me it sounds like we can close it since it's moved to an upstream source and the files here will vanish soon. Do you agree Sean Wheeler (@sdwheeler) ?

Christoph Bergmeister (@bergmeister) I agree. However, there is still the change to Utils/RuleMaker.psm1 that needs to be made. If we merge this then we get that change. The other doc will be delete in a month so the changes to it can be merged as is. The doc is already published to the live site at https://docs.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules-recommendations. So the broken links are not an issue.

Fix broken links to old .md files, set correct root directory for Get…

b72b8bc

…-RuleDocumentationPath function

Andy Jordan (andyleejordan) approved these changes Oct 14, 2021

View reviewed changes

Comment thread Utils/RuleMaker.psm1

Rob Holt (rjmholt) suggested changes Oct 14, 2021

View reviewed changes

Andy Jordan (andyleejordan) requested changes Oct 14, 2021

View reviewed changes

Change folder paths to markdown files under /docs/Rules

2c6c961

Andy Jordan (andyleejordan) approved these changes Oct 18, 2021

View reviewed changes

Fabian Geiger (fabge) and others added 2 commits January 3, 2022 14:51

Merge branch 'master' into fix-broken-links

7020b54

Merge branch 'master' into fix-broken-links

555c305

Christoph Bergmeister (bergmeister) added the Area - Documentation label Mar 29, 2022

Christoph Bergmeister (bergmeister) approved these changes Mar 29, 2022

View reviewed changes

Andy Jordan (andyleejordan) requested a review from James Truher (JamesWTruher) April 7, 2022 18:59

This pull request was closed.

-              - Must call ShouldProcess when ShouldProcess attribute is present and vice versa.[UseShouldProcess](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/RuleDocumentation/ShouldProcess.md)
-              - Nouns should be singular [UseSingularNouns](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/RuleDocumentation/UseSingularNouns.md)
-              - Module Manifest Fields [MissingModuleManifestField](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/RuleDocumentation/MissingModuleManifestField.md)
+              - Use Only Approved Verbs [UseApprovedVerbs](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/Rules/UseApprovedVerbs.cs)

-              - Global variables should be avoided. [AvoidGlobalVars](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/Rules/AvoidGlobalVars.cs)
-              - Declared variables must be used in more than just their assignment. [UseDeclaredVarsMoreThanAssignments](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/Rules/UseDeclaredVarsMoreThanAssignments.cs)
-              - No Invoke-Expression [AvoidUsingInvokeExpression](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/Rules/AvoidUsingInvokeExpression.cs)
+              - Avoid using alias [AvoidAlias](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Rules/AvoidAlias.md) #TODO not found

	- Empty catch block should not be used [AvoidEmptyCatchBlock](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Rules/AvoidUsingEmptyCatchBlock.md)
	- Empty catch block should not be used [AvoidUsingEmptyCatchBlock](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Rules/AvoidUsingEmptyCatchBlock.md)

	- Positional parameters should be avoided [AvoidPositionalParameters](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Rules/AvoidUsingPositionalParameters.md)
	- Positional parameters should be avoided [AvoidUsingPositionalParameters](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Rules/AvoidUsingPositionalParameters.md)

               ### Severity: Warning
-              - Password = 'string' should not be used. (information disclosure) [AvoidUserNameAndPasswordParams](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/Rules/AvoidUserNameAndPasswordParams.cs)
+              - Password = 'string' should not be used. (information disclosure) [AvoidUserNameAndPasswordParams](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Rules/AvoidUsingUsernameAndPasswordParams.md)

	- Password = 'string' should not be used. (information disclosure) [AvoidUserNameAndPasswordParams](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Rules/AvoidUsingUsernameAndPasswordParams.md)
	- Password = 'string' should not be used. (information disclosure) [AvoidUsingUserNameAndPasswordParams](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Rules/AvoidUsingUsernameAndPasswordParams.md)

	- Avoid using alias [AvoidAlias](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Rules/AvoidAlias.md) #TODO not found
	- Avoid using cmdlet aliases [AvoidUsingCmdletAliases](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Rules/AvoidUsingCmdletAliases.md)

Fix broken links to old .md files, set correct root directory for Get-RuleDocumentationPath function by fabge · Pull Request #1730 · PowerShell/PSScriptAnalyzer · GitHub

Uh oh!

Fix broken links to old .md files, set correct root directory for Get-RuleDocumentationPath function - #1730

Fix broken links to old .md files, set correct root directory for Get-RuleDocumentationPath function#1730Fabian Geiger (fabge) wants to merge 4 commits intoPowerShell:masterPowerShell/PSScriptAnalyzer:masterfrom fabge:fix-broken-linksCopy head branch name to clipboard

Conversation

Fabian Geiger (fabge) commented Oct 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Checklist

Uh oh!

Deleted user (ghost) commented Oct 14, 2021 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Andy Jordan (andyleejordan) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Rob Holt (rjmholt) Oct 14, 2021

Choose a reason for hiding this comment

Uh oh!

Andy Jordan (andyleejordan) left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Rob Holt (rjmholt) commented Oct 14, 2021

Uh oh!

Fabian Geiger (fabge) commented Oct 17, 2021

Uh oh!

Andy Jordan (andyleejordan) left a comment

Choose a reason for hiding this comment

Uh oh!

Andy Jordan (andyleejordan) Oct 18, 2021

Choose a reason for hiding this comment

Uh oh!

Andy Jordan (andyleejordan) Oct 18, 2021

Choose a reason for hiding this comment

Uh oh!

Andy Jordan (andyleejordan) Oct 18, 2021

Choose a reason for hiding this comment

Uh oh!

Andy Jordan (andyleejordan) Oct 18, 2021

Choose a reason for hiding this comment

Uh oh!

Christoph Bergmeister (bergmeister) left a comment

Choose a reason for hiding this comment

Uh oh!

Sean Wheeler (sdwheeler) commented Mar 30, 2022

Uh oh!

Fabian Geiger (fabge) commented Apr 7, 2022

Uh oh!

Andy Jordan (andyleejordan) commented Apr 7, 2022

Uh oh!

Christoph Bergmeister (bergmeister) commented Apr 7, 2022

Uh oh!

Sean Wheeler (sdwheeler) commented Apr 7, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Fix broken links to old .md files, set correct root directory for Get-RuleDocumentationPath function#1730
Fabian Geiger (fabge) wants to merge 4 commits into
PowerShell:masterfrom
fabge:fix-broken-links

Fabian Geiger (fabge) commented Oct 14, 2021 •
edited
Loading

Deleted user (ghost) commented Oct 14, 2021 •
edited by ghost
Loading

Andy Jordan (andyleejordan) left a comment •
edited
Loading