Skip to content

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

Merged
merged 10 commits into from
Sep 25, 2018

Conversation

rjmholt
Copy link
Contributor

@rjmholt rjmholt commented Sep 21, 2018

PR Summary

Did some updating of our main documentation:

  • Put myself into the maintainers list (😉)
  • Updated troubleshooting.md and turned it into a full issue walkthrough document
  • Changed the bug report template slightly to point to troubleshooting.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.

  • PR has a meaningful title
  • Summarized changes
  • 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

Copy link
Member

@TylerLeonhardt TylerLeonhardt left a 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! 🎉

Copy link
Collaborator

@SeeminglyScience SeeminglyScience left a 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.

$pseditor.EditorServicesVersion
code --list-extensions --show-versions
$PSVersionTable
> code -v
Copy link
Contributor

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.

Copy link
Contributor Author

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

Copy link
Contributor Author

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

Copy link
Contributor

@rkeithhill rkeithhill Sep 22, 2018

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.

Copy link
Contributor

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)"}

@rjmholt rjmholt merged commit b6972a7 into PowerShell:master Sep 25, 2018
@rkeithhill
Copy link
Contributor

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 & { and trailing } it will work pre-PSRL but it will have intermediate prompt strings and commands in the output.

@rjmholt
Copy link
Contributor Author

rjmholt commented Sep 25, 2018

I think I've got it fixed in master now -- took out the newlines and replaced them with semicolons.

@rjmholt
Copy link
Contributor Author

rjmholt commented Sep 25, 2018

(Tested in VSCode without PSRL first)

@rjmholt rjmholt deleted the update-documentation branch December 12, 2018 06:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants