Merge pull request #650 from gjsjohnmurray/prepare-1.0.11

Update README and CHANGELOG for 1.0.11

Author: gjsjohnmurray

CHANGELOG.md

@@ -1,5 +1,25 @@
 # Change Log
 
+## [1.0.11] 12-May-2021
+- Support client-side web app (CSP) workflow as long as web app path is in the `/csp/*` space (#147, #449)
+- Add compile-only commands 'Compile Current File' and 'Compile Current File with Specified Flags...' (#595)
+- Add 'Edit Other' command plus menu option below 'View Other' (#309)
+- Report server-side errors from imports and isfs saves (#391)
+- Use web app token when authenticating with Management Portal and Class Reference.
+- Permit empty argument list in 'Debug this' (#642)
+- Add `objectscript.compileOnSave` setting to turn off post-save compile (#594)
+- Treat `system=1` parameter on non-%SYS `isfs` folder spec as signal to include %-items (#623)
+- Add `objectscript.multilineMethodArgs` setting to use UDL parameter supported on servers with API version 4+ (#457)
+- Add snippets for business processes.
+- Prevent leading space in front of Class keyword from blocking import (#613)
+- Import into the correct namespace when working with multi-root workspace (#535)
+- Refactor 'Jump to Line' to use DocumentSymbolProvider.
+- Improve 'View Other' when working with servers supporting API version 4+ (#363)
+- Support Language Server enhancement that opens local copy of file when using 'Go to Definition' in client-side editing mode.
+- Update connections when settings are changed (#608)
+- Improve documentation.
+- Upgrade vulnerable dependencies.
+
 ## [1.0.10] 26-Apr-2021
 - Avoid prompting for already-saved password (#61)
 - Constrain QuickOpen list contents when `isfs` folder path targets a specific package (#581)
@@ -35,7 +55,7 @@
 ## [1.0.7] 4-Jan-2021
 - Fix issue affecting use with Docker on Windows (#516)
 - Resolve problem debugging in a multi-root workspace using isfs (#387)
-- Allow 'View other' from custom Studio documents.
+- Allow 'View Other' from custom Studio documents.
 - Fix issue that prevented saving of custom Studio documents.
 - Add code snippets for Request, Response and multi-superclass class definitions, Projection, XData, Try Catch, $$$ThrowOnError macro.
 - Upgrade vulnerable dependency.

README.md

@@ -12,7 +12,7 @@
 
 - Documentation on [GitHub Pages](https://intersystems-community.github.io/vscode-objectscript/).
 
-- Guidance on [reporting issues](https://community.intersystems.com/post/using-intersystems-objectscript-vs-code-how-report-issues).
+- Guidance on [reporting issues](https://community.intersystems.com/post/using-intersystems-objectscript-vs-code-how-report-issues). This guidance also appears in a later section of this document.
 
 ## Features
 
@@ -38,10 +38,11 @@
 
 Install [Visual Studio Code](https://code.visualstudio.com/) first.
 
-Open VS Code. Go to Extensions view (<kbd>⌘</kbd>/<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>X</kbd>), search for "vscode-objectscript" and install it.
-Or install direct from the ObjectScript extension page on [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=intersystems-community.vscode-objectscript).
+Then to get a set of extensions that collaborate to bring you a great ObjectScript development experience, install the [InterSystems ObjectScript Extension Pack](https://marketplace.visualstudio.com/items?itemName=intersystems-community.objectscript-pack).
 
-![installation](https://raw.githubusercontent.com/intersystems-community/vscode-objectscript/master/images/installation.gif)
+When you install an extension pack VS Code installs any of its members that you don't already have. Then if you ever need to switch off all of those extensions (for example, in a VS Code workspace on a non-ObjectScript project) simply disable the extension pack at the desired level. Member extensions can still be managed individually.
+
+Open VS Code. Go to Extensions view (<kbd>⌘</kbd>/<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>X</kbd>), use the search string **@id:intersystems-community.objectscript-pack** and install it.
 
 ## Enable Proposed APIs
 
@@ -55,8 +56,8 @@ To unlock these features (optional):
 
 1. Download and install a beta version from GitHub. This is necessary because Marketplace does not allow publication of extensions that use proposed APIs.
 	- Go to https://github.com/intersystems-community/vscode-objectscript/releases
-	- Locate the beta immediately above the release you installed from Marketplace. For instance, if you installed `1.0.10`, look for `1.0.11-beta.1`. This will be functionally identical to the Marketplace version apart from being able to use proposed APIs.
-	- Download the VSIX file (for example `vscode-objectscript-1.0.11-beta.1.vsix`) and install it. One way to install a VSIX is to drag it from your download folder and drop it onto the list of extensions in the Extensions view of VS Code.
+	- Locate the beta immediately above the release you installed from Marketplace. For instance, if you installed `1.0.11`, look for `1.0.12-beta.1`. This will be functionally identical to the Marketplace version apart from being able to use proposed APIs.
+	- Download the VSIX file (for example `vscode-objectscript-1.0.12-beta.1.vsix`) and install it. One way to install a VSIX is to drag it from your download folder and drop it onto the list of extensions in the Extensions view of VS Code.
 
 2. From [Command Palette](https://code.visualstudio.com/docs/getstarted/tips-and-tricks#_command-palette) choose `Preferences: Configure Runtime Arguments`.
 3. In the argv.json file that opens, add this line:
@@ -107,6 +108,47 @@ To edit code directly in one or more namespaces on one or more servers (local or
 
 For more about `isfs` and `isfs-readonly` folder specifications see the [Notes](#Notes) section below.
 
+## Reporting Issues
+
+[InterSystems ObjectScript for VS Code](https://intersystems-community.github.io/vscode-objectscript/) consists of three collaborating VS Code extensions. This modular architecture also means there are three different GitHub repositories where issues can be created. Fortunately VS Code itself helps with the task. You will need a GitHub account. Here's how:
+
+1. From the Help menu in VS Code choose 'Report Issue'. Alternatively, open the Command Palette and run `Help: Report Issue...`.
+
+2. When the dialog appears, use the first dropdown to classify your issue:
+    - Bug Report
+    - Feature Request
+    - Performance Issue
+
+3. In the second dropdown pick 'An extension'
+
+4. The third dropdown lets you pick one of your installed extensions. You can type a few characters to find the right entry. For example, `isls` quickly selects "InterSystems Language Server".
+
+   Which one to choose? Here's a guide:
+   - InterSystems Language Server
+        - code coloring
+        - Intellisense
+   - InterSystems ObjectScript
+        - export, import and compile
+        - ObjectScript Explorer (browsing namespace contents)
+        - direct server-side editing using `isfs://` folders in a workspace
+        - integration with server-side source control etc
+   -  InterSystems Server Manager
+        - Server Browser on the InterSystems Tools view
+        - password management in local keychain
+        - definition and selection of entries in `intersystems.servers`
+
+    If unsure, pick InterSystems ObjectScript.
+
+5. Type a descriptive one-line summary of your issue. The dialog may offer a list of existing issues which could be duplicates. If you don't find one that covers yours, proceed.
+
+6. Enter details. If your VS Code is authenticated to GitHub the dialog's button is captioned "Create on GitHub" and clicking it will open the issue, then load it in your browser so you can edit it. Otherwise it reads "Preview on GitHub" and launches a browser page where you must complete and submit your report.
+
+   Tips for use on the GitHub page:
+
+    - Paste images from your clipboard directly into the report field. For hard-to-describe issues an animated GIF or a short MP4 gets bonus points. The `Developer: Toggle Screencast Mode` in VS Code can help your recording make more sense.
+    - Link to other issues by prefixing the target number with #
+    - Remember that whatever you post here is visible to anyone on the Internet. Mask/remove confidential information. Be polite.
+
 ## Notes
 
 - Connection-related output appears in the 'Output' view while switched to the 'ObjectScript' channel using the drop-down menu on the view titlebar.