-
Notifications
You must be signed in to change notification settings - Fork 510
Update troubleshooting.md and associated docs #1541
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
Conversation
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.
This is awesome, Rob. So much cleaner. LGTM! 🎉
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.
This is great! Just one bug in the links.
.github/ISSUE_TEMPLATE/Bug_report.md
Outdated
$pseditor.EditorServicesVersion | ||
code --list-extensions --show-versions | ||
$PSVersionTable | ||
> code -v |
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.
By adding the >
it makes it harder to copy/paste into the PSIC. Now you have to manually remove >
chars in order to execute the commands. We might also want to mention that there is a PowerShell extension command Upload Bug Report to Github
to generate a bug report that will automatically include all of the info above. Well, when it works ... sigh. That's another bug to look into.
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.
Yeah I was vacillating between the two. I keep seeing issues where those commands aren't executed properly or the output is dumped into the issue with no formatting and is unreadable.
I was thinking maybe the >
would prompt people to put the output underneath to break up the issue better... But maybe it's not a good idea?
There's a reference to the open bug command in troubleshooting.md, but I can put one in the template as well
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.
Wait the Upload Bug Report to GitHub
is already in the template -- second line in the comment
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.
Oh yeah, didn't see that there in MD view.
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.
We could try something like this:
& {"### VSCode version: $(code -v)"
"`n### VSCode extensions:`n$(code --list-extensions --show-versions | Out-String)"
"`n### PSES version: $($pseditor.EditorServicesVersion)"
"`n### PowerShell version: $($PSVersionTable | Out-String)"}
Doh! The pasteable script for getting env info works great if you have PSRL enabled. But not so well if you don't. That's one downside I guess to living/testing on the bleeding edge. If we lose the starting |
I think I've got it fixed in |
(Tested in VSCode without PSRL first) |
PR Summary
Did some updating of our main documentation:
troubleshooting.md
and turned it into a full issue walkthrough documenttroubleshooting.md
Anything else I should add while I'm at it?
PR Checklist
Note: Tick the boxes below that apply to this pull request by putting an
x
between the square brackets.Please mark anything not applicable to this PR
NA
.WIP:
to the beginning of the title and remove the prefix when the PR is ready