Skip to content

Commit

Permalink
Merge pull request #2061 from PowerShell/Doc-Updates
Browse files Browse the repository at this point in the history
Doc updates
  • Loading branch information
SydneyhSmith authored Jul 1, 2019
2 parents f6f7313 + 4dd621d commit 8d8390f
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 240 deletions.
2 changes: 1 addition & 1 deletion docs/azure_data_studio/README_FOR_MARKETPLACE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![Join the chat at https://gitter.im/PowerShell/vscode-powershell](https://badges.gitter.im/PowerShell/vscode-powershell.svg)](https://gitter.im/PowerShell/vscode-powershell?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

This extension provides rich PowerShell language support for [Azure Data Studio](github.com/Microsoft/azuredatastudio).
Now you can write and debug PowerShell scripts using the excellent IDE-like interface
Now you can write and run PowerShell scripts using the excellent IDE-like interface
that Azure Data Studio provides.

## Platform support
Expand Down
14 changes: 1 addition & 13 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ to before you can proceed.
Insiders means the extension can be developed ready for new features
and changes in the next VSCode release.

5. Install [Node.js](https://nodejs.org/en/) 8.x or higher.
5. Install [Node.js](https://nodejs.org/en/) 10.x or higher.

## Building the Code

Expand Down Expand Up @@ -45,18 +45,6 @@ press <kbd>Ctrl</kbd>+<kbd>F5</kbd> or <kbd>Cmd</kbd>+<kbd>F5</kbd> on macOS.
code --extensionDevelopmentPath="c:\path\to\vscode-powershell" .
```

## Building a "Preview" version

To build a preview version of the extension, that is to say,
a version of the extension named "PowerShell Preview",
You can simply change the `name` in the package.json to include `-Preview` at the end.
When you build, this will:

- Add a warning to the top of the README.md to warn users not to have the stable and preview version enabled at the same time
- Adds "Preview" in a few places in the package.json

This mechanism is mostly used for releases

## Contributing Snippets

For more information on contributing snippets please read our [snippet requirements](https://github.com/PowerShell/vscode-powershell/blob/master/docs/community_snippets.md#contributing).
131 changes: 0 additions & 131 deletions docs/ise_compatibility.md

This file was deleted.

87 changes: 0 additions & 87 deletions docs/remoting.md

This file was deleted.

16 changes: 8 additions & 8 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ and you can ask for new features [in their repository](https://github.com/Micros
- Highlighting/completions/command history don't work as I expect in the
Integrated Console - [#535]
- The Integrated Console implements a [custom host]
to work with VSCode, making it incompatible with
[PSReadLine] (the module providing these features in regular PowerShell).
Resolving this incompatibility is being actively worked on.
to work with VSCode, meaning that functionality could be different than that of the regular host in the PowerShell Console
- [PSReadLine] (the module providing these features in regular PowerShell) is available in the PowerShell Preview Extension, helping to bridge this gap
- Making PSReadline fully available is being actively worked on.
- Command history is not preserved when debugging in the Integrated Console -
[#550]
- This feature is also provided by [PSReadLine].
Expand All @@ -61,8 +61,7 @@ and you can ask for new features [in their repository](https://github.com/Micros
- "Go to Definition" doesn't work through module imports - [#499]
- Again this is a best-effort task.
- Completions don't cycle when <kbd>Tab</kbd> is pressed like in the ISE - [#25]
- VSCode itself provides the user experience for completions, and they
currently don't allow us to customize this.
- [Use the tab comletion settings in VSCode](https://docs.microsoft.com/en-us/powershell/scripting/components/vscode/how-to-replicate-the-ise-experience-in-vscode?view=powershell-6#tab-completion)
- My command that opens a dialog does nothing - [#410 (comment)]
- Check that the dialog hasn't opened behind VSCode. This is a known
[VSCode issue].
Expand All @@ -76,6 +75,7 @@ and you can ask for new features [in their repository](https://github.com/Micros
may be opportunities to improve our integration with it in the
[PowerShell Extension] too.
- `Write-Progress` doesn't output to the console - [#140]
- `Write-Progress` is available in the PowerShell Preview Extension

## Reporting an Issue

Expand Down Expand Up @@ -133,7 +133,8 @@ For solving most issues, the following information is important to provide:

### Logs

Logs provide context for what was happening when the issue occurred
Logs provide context for what was happening when the issue occurred.
**Note: You should skim through your logs for any sensitive information you would not like to share online**

- Before sending through logs, try and reproduce the issue with
**log level set to Verbose** or **Diagnostic**. You can set this
Expand All @@ -148,7 +149,6 @@ Logs provide context for what was happening when the issue occurred
```json
"powershell.developer.editorServicesLogLevel": "Diagnostic"
```

After you have captured the issue with the log level turned up,
you may want to return it (since verbose logging can use disk space):

Expand All @@ -171,7 +171,7 @@ Logs provide context for what was happening when the issue occurred
For example:

```powershell
$HOME/vscode/extensions/ms-vscode.powershell-1.8.4/logs
$HOME/vscode/extensions/ms-vscode.powershell-2019.5.1/logs
```

- In VSCode you can open and read the logs directly from the [Command Palette]
Expand Down

0 comments on commit 8d8390f

Please sign in to comment.