-
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
Merged
Merged
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
745e472
Update and restructure README.md
fa90146
Update troubleshooting.md
1f7d91c
Info on opening an issue
98df542
Update README to point at troubleshooting doc
1257819
Fix omissions in troubleshooting doc
e84694c
Update bug template to point to troubleshooting.md
e5f1a60
Put PowerShell project links in correct alphabetical order
e59f41c
Fix broken github link to the extension
rjmholt d45df8e
Suggest recording a GIF of bugs
rjmholt 29f2388
Use pasteable version expression in bug report
rjmholt File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,9 +8,9 @@ that Visual Studio Code provides. | |
|
|
||
| ## Platform support | ||
|
|
||
| - **Windows 7 through 10** with PowerShell v3 and higher | ||
| - **Linux** with PowerShell v6 (all PowerShell-supported distributions) | ||
| - **macOS and OS X** with PowerShell v6 | ||
| - **Windows 7 through 10** with Windows PowerShell v3 and higher, and PowerShell Core | ||
| - **Linux** with PowerShell Core (all PowerShell-supported distributions) | ||
| - **macOS and OS X** with PowerShell Core | ||
|
|
||
| Read the [installation instructions](https://github.com/PowerShell/PowerShell/blob/master/docs/learning-powershell/using-vscode.md) | ||
| to get more details on how to use the extension on these platforms. | ||
|
|
@@ -26,11 +26,28 @@ Read the [FAQ](https://github.com/PowerShell/vscode-powershell/wiki/FAQ) for ans | |
| - Go to Definition of cmdlets and variables | ||
| - Find References of cmdlets and variables | ||
| - Document and workspace symbol discovery | ||
| - Run selected selection of PowerShell code using `F8` | ||
| - Launch online help for the symbol under the cursor using `Ctrl+F1` | ||
| - Run selected selection of PowerShell code using <kbd>F8</kbd> | ||
| - Launch online help for the symbol under the cursor using <kbd>Ctrl</kbd>+<kbd>F1</kbd> | ||
| - Local script debugging and basic interactive console support! | ||
|
|
||
| ## Quick Installation | ||
| ## Installing the Extension | ||
|
|
||
| You can install the official release of the PowerShell extension by following the steps | ||
| in the [Visual Studio Code documentation](https://code.visualstudio.com/docs/editor/extension-gallery). | ||
| In the Extensions pane, search for "PowerShell" extension and install it there. You will | ||
| get notified automatically about any future extension updates! | ||
|
|
||
| You can also install a VSIX package from our [Releases page](https://github.com/PowerShell/vscode-powershell/releases) by following the | ||
| [Install from a VSIX](https://code.visualstudio.com/docs/extensions/install-extension#_install-from-a-vsix) | ||
| instructions. The easiest way is through the command line: | ||
|
|
||
| ``` | ||
| code --install-extension PowerShell-<version>.vsix | ||
| ``` | ||
|
|
||
| > NOTE: If you are using VS Code Insiders, the command will be `code-insiders`. | ||
|
|
||
| ## Script-based Installation | ||
|
|
||
| If you're on Windows 7 or greater with the [PowerShellGet](https://msdn.microsoft.com/powershell/gallery/readme) | ||
| module installed, you can easily install both Visual Studio Code and the PowerShell | ||
|
|
@@ -52,22 +69,14 @@ first before running it in this way! | |
| iex (iwr https://git.io/vbxjj) | ||
| ``` | ||
|
|
||
| ## Installing the Extension | ||
|
|
||
| You can install the official release of the PowerShell extension by following the steps | ||
| in the [Visual Studio Code documentation](https://code.visualstudio.com/docs/editor/extension-gallery). | ||
| In the Extensions pane, search for "PowerShell" extension and install it there. You will | ||
| get notified automatically about any future extension updates! | ||
|
|
||
| You can also install a VSIX package from our [Releases page](https://github.com/PowerShell/vscode-powershell/releases) by following the | ||
| [Install from a VSIX](https://code.visualstudio.com/docs/extensions/install-extension#_install-from-a-vsix) | ||
| instructions. The easiest way is through the command line: | ||
| ## Reporting Problems | ||
|
|
||
| ``` | ||
| code --install-extension PowerShell-<version>.vsix | ||
| ``` | ||
| If you experience any problems with the PowerShell Extension, see | ||
| [the troubleshooting docs](./docs/troubleshooting.md) for information | ||
| on diagnosing and reporting issues. | ||
|
|
||
| > NOTE: If you are using VS Code Insiders, the command will be `code-insiders`. | ||
| #### Security Note | ||
| For any security issues, please see [here](./docs/troubleshooting.md#note-on-security). | ||
|
|
||
| ## Example Scripts | ||
|
|
||
|
|
@@ -88,48 +97,6 @@ To open/view the extension's examples in Visual Studio Code, run the following f | |
| code (Get-ChildItem $Home\.vscode\extensions\ms-vscode.PowerShell-*\examples)[-1] | ||
| ``` | ||
|
|
||
| ## Reporting Problems | ||
|
|
||
| If you're having trouble with the PowerShell extension, please follow these instructions | ||
| to file an issue on our GitHub repository: | ||
|
|
||
| ### 1. File an issue on our [Issues Page](https://github.com/PowerShell/vscode-powershell/issues) | ||
|
|
||
| Make sure to fill in the information that is requested in the issue template as it | ||
| will help us investigate the problem more quickly. | ||
|
|
||
| To automatically create a bug report from within the extension, open the Command pallet (<kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>) and run the *"Report a problem on GitHub"* command. Some basic information about your instance and powershell versions will be collected and inserted into a new GitHub issue. | ||
|
|
||
| NOTE: If you believe that there is a security vulnerability in the PowerShell extension for VSCode, | ||
| it **must** be reported to [[email protected]](https://technet.microsoft.com/security/ff852094.aspx) to allow for [Coordinated Vulnerability Disclosure](https://technet.microsoft.com/security/dn467923). | ||
| **Only** file an issue, if [email protected] has confirmed filing an issue is appropriate. | ||
|
|
||
| ### 2. Capture verbose logs and send them to us | ||
|
|
||
| If you're having an issue with crashing or other erratic behavior, add the following | ||
| line to your User Settings in Visual Studio Code: | ||
|
|
||
| ```json | ||
| "powershell.developer.editorServicesLogLevel": "Verbose" | ||
| ``` | ||
|
|
||
| Restart Visual Studio Code and try to reproduce the problem. Once you are done with | ||
| that, zip up the logs in the corresponding folder for your operating system: | ||
|
|
||
| - **Windows**: `$HOME\.vscode\extensions\ms-vscode.PowerShell-<CURRENT VERSION>\logs` | ||
| - **Linux and macOS**: `~/.vscode/extensions/ms-vscode.PowerShell-<CURRENT VERSION>/logs` | ||
|
|
||
| Alternatively, you can open the log folder using the Command pallet (<kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>) and running the *"Open powerShell Extension Logs Folder"* command. | ||
|
|
||
| You have two options for sending us the logs: | ||
|
|
||
| 1. If you are editing scripts that contain sensitive information (intellectual property, | ||
| deployment or administrative information, etc), e-mail the logs directly to | ||
| *[email protected]*. | ||
|
|
||
| 2. If you are editing scripts that don't contain sensitive information, you can drag and | ||
| drop your logs ZIP file into the GitHub issue that you are creating. | ||
|
|
||
| ## Contributing to the Code | ||
|
|
||
| Check out the [development documentation](docs/development.md) for more details | ||
|
|
@@ -139,7 +106,7 @@ on how to contribute to this extension! | |
|
|
||
| - [Keith Hill](https://github.com/rkeithhill) - [@r_keith_hill](http://twitter.com/r_keith_hill) | ||
| - [Tyler Leonhardt](https://github.com/tylerl0706) - [@TylerLeonhardt](http://twitter.com/tylerleonhardt) | ||
| - [David Wilson](https://github.com/daviwil) - [@daviwil](http://twitter.com/daviwil) | ||
| - [Rob Holt](https://github.com/rjmholt) | ||
|
|
||
| ## License | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 commandUpload Bug Report to Githubto 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 GitHubis already in the template -- second line in the commentThere 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: