MethodsAndPractices / vsteam

PowerShell module for accessing Azure DevOps Services and Azure DevOps Server (formerly VSTS or TFS)
https://methodsandpractices.github.io/vsteam-docs/
MIT License
447 stars 155 forks source link

Doku: Rework the notes section to not show default related links in all cmdlets #436

Closed SebastianSchuetze closed 2 years ago

SebastianSchuetze commented 2 years ago

Content of the issue has been copied from PR #418 by @smholvoet


Another suggestion (which I have not yet pushed to my branch) is reworking the Notes section. I personally think it's very annoying seeing relevant cmdlets mentioned there, which are not clickable. Granted, they are mentioned a bit further down in the Related links section, but I think making the cmdlets clickable in the Notes section prevents a user from having to scroll further down and find the exact cmdlet he was looking for in a list of (sometimes) many more cmdlets:

image

Noticed some cmdlets have related links which get added below the cmdlets which are displayed through the prerequisites.md file, for example Update-VSTeamPolicy, which I think is particularly useful.

In summary:

Remove from the Related links section Rework the Notes section to include link, making things easier for users