-
Notifications
You must be signed in to change notification settings - Fork 157
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
✏️ Added work item tag cmdlets to Get, Remove and Update, also fixed typos and casing #418
✏️ Added work item tag cmdlets to Get, Remove and Update, also fixed typos and casing #418
Conversation
@smholvoet Are you talking about the github docs pages regarding the links of the source markdown pages? |
@SebastianSchuetze I'm indeed talking about the docs page, for example: Get-VSTeamAccounts. So in short:
|
@DarqueWarrior what was the intention to add the standard related texts in every cmdlet? Is this nessecary to mention it everywhere? |
@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.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Checked your current code.
Since unit tests are failing, then I guess you are not finished yet.
@smholvoet any update on your PR? |
@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).
|
No it's fine. You can rework. Please just do it in an extra PR. Thanks for the support. Appreciate it! |
@smholvoet got any time to finish it? :-) |
@smholvoet thanks for you work! Please also check the builds. Your unit tests do not seem to go through. Without this we cannot merge. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just saw the file docs/synopsis/Update-VSTeamWorkItemTag.md
Synopsis is missing there.
You can also run the unit tests locally to check if they work.
https://github.com/MethodsAndPractices/vsteam/blob/trunk/README.md#how-to-build-locally
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made quite some changes to the unit test. I guess you didn't run them at all locally. :-)
But really thank you for introducing this. I need to check a view more things, then I can merge this.
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:
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:
<!-- #include "./common/related.md" -->
from the Related links sectionLet me know what you think and I'll push additional changes to this branch should you agree with the above suggestion.
PR Checklist