Skip to content

Commit 8d8390f

Browse files
authored
Merge pull request #2061 from PowerShell/Doc-Updates
Doc updates
2 parents f6f7313 + 4dd621d commit 8d8390f

File tree

5 files changed

+10
-240
lines changed

5 files changed

+10
-240
lines changed

docs/azure_data_studio/README_FOR_MARKETPLACE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![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)
66

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

1111
## Platform support

docs/development.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ to before you can proceed.
1616
Insiders means the extension can be developed ready for new features
1717
and changes in the next VSCode release.
1818

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

2121
## Building the Code
2222

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

48-
## Building a "Preview" version
49-
50-
To build a preview version of the extension, that is to say,
51-
a version of the extension named "PowerShell Preview",
52-
You can simply change the `name` in the package.json to include `-Preview` at the end.
53-
When you build, this will:
54-
55-
- 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
56-
- Adds "Preview" in a few places in the package.json
57-
58-
This mechanism is mostly used for releases
59-
6048
## Contributing Snippets
6149

6250
For more information on contributing snippets please read our [snippet requirements](https://github.com/PowerShell/vscode-powershell/blob/master/docs/community_snippets.md#contributing).

docs/ise_compatibility.md

-131
This file was deleted.

docs/remoting.md

-87
This file was deleted.

docs/troubleshooting.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ and you can ask for new features [in their repository](https://github.com/Micros
4242
- Highlighting/completions/command history don't work as I expect in the
4343
Integrated Console - [#535]
4444
- The Integrated Console implements a [custom host]
45-
to work with VSCode, making it incompatible with
46-
[PSReadLine] (the module providing these features in regular PowerShell).
47-
Resolving this incompatibility is being actively worked on.
45+
to work with VSCode, meaning that functionality could be different than that of the regular host in the PowerShell Console
46+
- [PSReadLine] (the module providing these features in regular PowerShell) is available in the PowerShell Preview Extension, helping to bridge this gap
47+
- Making PSReadline fully available is being actively worked on.
4848
- Command history is not preserved when debugging in the Integrated Console -
4949
[#550]
5050
- This feature is also provided by [PSReadLine].
@@ -61,8 +61,7 @@ and you can ask for new features [in their repository](https://github.com/Micros
6161
- "Go to Definition" doesn't work through module imports - [#499]
6262
- Again this is a best-effort task.
6363
- Completions don't cycle when <kbd>Tab</kbd> is pressed like in the ISE - [#25]
64-
- VSCode itself provides the user experience for completions, and they
65-
currently don't allow us to customize this.
64+
- [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)
6665
- My command that opens a dialog does nothing - [#410 (comment)]
6766
- Check that the dialog hasn't opened behind VSCode. This is a known
6867
[VSCode issue].
@@ -76,6 +75,7 @@ and you can ask for new features [in their repository](https://github.com/Micros
7675
may be opportunities to improve our integration with it in the
7776
[PowerShell Extension] too.
7877
- `Write-Progress` doesn't output to the console - [#140]
78+
- `Write-Progress` is available in the PowerShell Preview Extension
7979

8080
## Reporting an Issue
8181

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

134134
### Logs
135135

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

138139
- Before sending through logs, try and reproduce the issue with
139140
**log level set to Verbose** or **Diagnostic**. You can set this
@@ -148,7 +149,6 @@ Logs provide context for what was happening when the issue occurred
148149
```json
149150
"powershell.developer.editorServicesLogLevel": "Diagnostic"
150151
```
151-
152152
After you have captured the issue with the log level turned up,
153153
you may want to return it (since verbose logging can use disk space):
154154

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

173173
```powershell
174-
$HOME/vscode/extensions/ms-vscode.powershell-1.8.4/logs
174+
$HOME/vscode/extensions/ms-vscode.powershell-2019.5.1/logs
175175
```
176176

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

0 commit comments

Comments
 (0)