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
444 stars 155 forks source link

✏️ Added work item tag cmdlets to Get, Remove and Update, also fixed typos and casing #418

Closed smholvoet closed 2 years ago

smholvoet commented 2 years ago

PR Summary

Fixed casing and a couple of minor typos.

Update by Maintainer (@SebastianSchuetze): New cmdlets where added by @smholvoet

Suggestion

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

I've 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 very useful.

In summary:

Let me know what you think and I'll push additional changes to this branch should you agree with the above suggestion.

PR Checklist

SebastianSchuetze commented 2 years ago

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

@smholvoet Are you talking about the github docs pages regarding the links of the source markdown pages?

smholvoet commented 2 years ago

@SebastianSchuetze I'm indeed talking about the docs page, for example: Get-VSTeamAccounts.

So in short:

  1. Remove the fixed commands which get added to the Related links section, which has been added to every command: image

  2. Rework the Notes section to include direct links to any cmdlet that gets mentioned there.

SebastianSchuetze commented 2 years ago

@DarqueWarrior what was the intention to add the standard related texts in every cmdlet? Is this nessecary to mention it everywhere?

SebastianSchuetze commented 2 years ago

@smholvoet you can remove the related part. You are right, that it may be deserve it's own page once instead of having it on every cmdlet.

@SebastianSchuetze I'm indeed talking about the docs page, for example: Get-VSTeamAccounts.

So in short:

  1. Remove the fixed commands which get added to the Related links section, which has been added to every command: image
  2. Rework the Notes section to include direct links to any cmdlet that gets mentioned there.
SebastianSchuetze commented 2 years ago

@smholvoet any update on your PR?

smholvoet commented 2 years ago

@SebastianSchuetze I'll rework this in the next couple of days, thank you for reviewing 👌

Can I go ahead and rework the "related links" section as well? This would impact 172 files (all cmdlets). Or should I hold off on this until @DarqueWarrior's response clears this up? 🤔

@DarqueWarrior what was the intention to add the standard related texts in every cmdlet? Is this nessecary to mention it everywhere?

SebastianSchuetze commented 2 years ago

No it's fine. You can rework. Please just do it in an extra PR.

Thanks for the support. Appreciate it!

SebastianSchuetze commented 2 years ago

@smholvoet got any time to finish it? :-)

SebastianSchuetze commented 2 years ago

@smholvoet thanks for you work! Please also check the builds. Your unit tests do not seem to go through. Without this we cannot merge.

image