Migrate to official ISC documentation (#1185)

Author: isc-bsaviano

CHANGELOG.md

@@ -79,7 +79,7 @@
 
 ## [2.2.0] 31-Oct-2022
 - Enhancements
-  - Add features to ease migration from Studio (see [Migrating from Studio documentation page](https://intersystems-community.github.io/vscode-objectscript/studio/) for details) (#1003)
+  - Add features to ease migration from Studio (see [Migrating from Studio documentation page](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_fromstudio) for details) (#1003)
   - Improve CodeLenses (#1007)
 - Fixes
   - Improve export error logging (#998)
@@ -136,7 +136,7 @@ Minimum VS Code version is now 1.66.0
 - Enhancements
   - Compile asynchronously to avoid timing out (#890)
   - Add `objectscript.explorer.alwaysShowServerCopy` setting to make ObjectScript Explorer always open server-side code, even when local copy exists (#494)
-  - Move issue reporting instructions from README to [documentation](https://intersystems-community.github.io/vscode-objectscript/feedback/) (#874)
+  - Move issue reporting instructions from README to [documentation](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_reporting) (#874)
 - Fixes
   - Fix syncing of local CSP files (#886)
   - Stop logging `Non-JSON response` messages to Output (#853)
@@ -406,7 +406,7 @@ Minimum VS Code version is now 1.66.0
 - Swap the two sides displayed by a compare invoked after local file import conflict. Server copy is now on the left, to match convention elsewhere in VS Code.
 - Fix `Import and Compile Current File`.
 - Exclude invalid commands from Command Palette.
-- New documentation site using [GitHub Pages](https://intersystems-community.github.io/vscode-objectscript/).
+- New documentation site using GitHub Pages.
 - Add API functions for use by other extensions.
 - Upgrade vulnerable dependencies.
 

README.md

@@ -8,19 +8,17 @@
 
 # InterSystems ObjectScript extension for VS Code
 
-> **Note:** The best way to install and use this extension is by installing the [InterSystems ObjectScript Extension Pack](https://marketplace.visualstudio.com/items?itemName=intersystems-community.objectscript-pack) and following the [documentation here](https://intersystems-community.github.io/vscode-objectscript/).
+> **Note:** The best way to install and use this extension is by installing the [InterSystems ObjectScript Extension Pack](https://marketplace.visualstudio.com/items?itemName=intersystems-community.objectscript-pack) and following the [documentation here](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO).
 
 [InterSystems®](http://www.intersystems.com) ObjectScript language support for Visual Studio Code, from the [InterSystems Developer Community](https://community.intersystems.com/).
 
-- Documentation on [GitHub Pages](https://intersystems-community.github.io/vscode-objectscript/).
+- Documentation on the [InterSystems Documentation site](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO).
 
-- Guidance on [reporting issues](https://intersystems-community.github.io/vscode-objectscript/feedback/).
+- Guidance on [reporting issues](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_reporting).
 
 ## Features
 
 - InterSystems ObjectScript code highlighting support.
-
-  ![example](https://raw.githubusercontent.com/intersystems-community/vscode-objectscript/master/images/screenshot.png)
 - Debugging ObjectScript code.
 - Intellisense support for commands, system functions, and class members.
 - Export of existing server sources into a working folder:
@@ -33,8 +31,6 @@
   - or, select `ObjectScript: Import and Compile Current File` from Command Palette
 - Direct access to edit or view server code in the VS Code Explorer via `isfs` and `isfs-readonly` FileSystemProviders (e.g. using a [multi-root workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces)). Server-side source control is respected.
 - Server Explorer view (ObjectScript: Explorer) with ability to export items to your working folder.
-
-  ![ServerExplorer](https://raw.githubusercontent.com/intersystems-community/vscode-objectscript/master/images/explorer.png)
 - Integration with with [InterSystems Server Manager](https://marketplace.visualstudio.com/items?itemName=intersystems-community.servermanager) for secure storage of connection passwords.
 
 ## Installation
@@ -75,42 +71,6 @@ intersystems-community.vscode-objectscript version X.Y.Z-beta.1 activating with
 
 After a subsequent update of the extension from Marketplace you will only have to download and install the new `vscode-objectscript-X.Y.Z-beta.1` VSIX. None of the other steps above are needed again.
 
-## Configure a Connection
-
-To be able to use many features you first need to configure the connection to your IRIS/Caché/Ensemble server(s) in your [VS Code settings](https://code.visualstudio.com/docs/getstarted/settings). If you are unfamiliar with how settings work and how they are edited, use that link.
-
-We recommend you define server connections in the `intersystems.servers` object whose structure is defined by the [InterSystems Server Manager](https://marketplace.visualstudio.com/items?itemName=intersystems-community.servermanager) helper extension.
-
-Install that extension and consult its documentation about its UI and commands for easy setup of connections, plus assistance when editing the JSON definition directly.
-
-For more tips about the `intersystems.servers` object, see the [Notes](#Notes) section below.
-
-### Client-side Editing
-
-A simple workspace -- a local working folder in which you edit InterSystems source files and manage them using client-side source control (e.g. Git) -- will use the `objectscript.conn` settings object to **import** locally-edited code into a namespace on a server, compile it there and run/debug it, and also for initial **export** of an existing codebase (optional). This settings object is usually defined in Workspace Settings, for example in the `.vscode/settings.json` file of your working folder.
-
-A quick way to add `objectscript.conn` to a new working folder is:
-
-1. Open the folder in VS Code.
-2. Use the InterSystems icon on the activity bar to switch to **ObjectScript Explorer** view.
-3. Click the 'Choose Server and Namespace' button.
-4. Respond to the sequence of quickpicks. You can also define a new server at the start of this sequence by using the '+' button.
-
-For more about `objectscript.conn` see the [Notes](#Notes) section below.
-
-### Server-side Editing
-
-To edit code directly in one or more namespaces on one or more servers (local or remote) we recommend creating a workspace definition file (for example _XYZ.code-workspace_) where you specify one or more root folders that directly access namespaces via the `isfs` or `isfs-readonly` URI schemes. The only difference between these two schemes is that any file opened from a folder using the `isfs-readonly` scheme will be set as read-only in VS Code and thus protected against being changed.
-
-1. Start VS Code.
-2. If your last-used folder opens, use 'Close Folder' on the 'File' menu ('Code' menu on macOS). Or if what opened was your last-used workspace, use 'Close Workspace'.
-3. On VS Code's Explorer view (<kbd>⌘</kbd>/<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>E</kbd>), click the 'Manage Servers' button which is contributed by the Server Manager extension.
-4. Find your target server in the tree, or use the '+' button to add a new server.
-5. Expand the server and its 'Namespaces' folder, then click on the 'pencil' icon for editing access to the namespace or the 'eye' icon for viewing access. If you want to work with web application files rather than classes and routines, hold down the <kbd>Alt</kbd>/<kbd>Option</kbd> key when clicking the button.
-6. Use 'Save Workspace As...' to store your workspace definition in a file with a `.code-workspace` extension.
-
-For more about `isfs` and `isfs-readonly` folder specifications see the [Notes](#Notes) section below.
-
 ## Notes
 
 - Connection-related output appears in the 'Output' view while switched to the 'ObjectScript' channel using the drop-down menu on the view titlebar.
@@ -122,82 +82,3 @@ For more about `isfs` and `isfs-readonly` folder specifications see the [Notes](
 ```SQL
 GRANT EXECUTE ON %Library.RoutineMgr_StudioOpenDialog TO xxx
 ```
-
-### More about `intersystems.servers`
-This settings object is useful for both client-side and server-side development.
-- An example server definition named 'local':
-
-```json
-  "intersystems.servers": {
-    "local": {
-      "webServer": {
-        "scheme": "http",
-        "host": "127.0.0.1",
-        "port": 52773
-      },
-      "description": "My local IRIS",
-      "username": "me"
-    }
-  }
-```
-
-- By defining connections in your User Settings they become available for use by any workspace you open in VS Code. Alternatively, define them in workspace-specific settings.
-
-- Setting the `username` property is optional. If omitted it will be prompted for when connecting, then cached for the session.
-
-- Setting a plaintext value for the `password` property is **not** recommended. Instead, install the InterSystems Server Manager extension and use that to store your password securely.
-
-- If no password has been set or stored it will be prompted for when connecting, then cached for the session.
-
-### More about `objectscript.conn`
-This settings object is primarily relevant when doing client-side development.
-- We recommend that `objectscript.conn` uses its `server` property to point to an entry in `intersystems.servers`. For example:
-
-```json
-  "objectscript.conn": {
-    "active": true,
-    "server": "local",
-    "ns": "USER"
-  }
-```
-
-- The mandatory `ns` property defines which server namespace you will work with.
-
-- When the `server` property is set, any `username` or `password` properties of `objectscript.conn` are ignored. Instead these values come from the `intersystems.servers` entry.
-
-### More about `isfs` and `isfs-readonly` workspace folders
-Server-side development is best done using `isfs` folders. The read-only variant `isfs-readonly` is also useful when doing client-side development, since it enables server-side searching of your codebase.
-
-To modify how your folder behaves, edit the JSON of your workspace definition (_XYZ.code-workspace_ file). Get there by using the 'Edit Settings' option from the context menu of Server Manager's 'Servers' view, or by running the 'Preferences: Open Workspace Settings (JSON)' command from the Command Palette. Edit your `uri` property.
-
-- The `csp` query parameter indicates web application files are to be shown. The uri path optionally specifies which application. The namespace suffix on the server name (preferred syntax) or the `ns` query parameter (deprecated) must specify the same namespace the application is configured to use. In the following example the first folder is for the `/csp/user` web application in the USER namespace of the server named 'local' and the second gives read-only access to all web applications that reside in the %SYS namespace. The second folder also uses the optional `name` property:
-```json
-    {
-      "uri": "isfs://local:user/csp/user?csp"
-    },
-    {
-      "name": "local:%SYS web files (read-only)",
-      "uri": "isfs-readonly://local/?ns=%SYS&csp"
-    }
-```
-  
-- To see only classes in the Xxx.Yyy package, format the uri like this:
-
-```json
-    {
-      "uri": "isfs://local:user/Xxx/Yyy?type=cls"
-    }
-```
-
-- Other query parameters that can be specified include:
-  - `type=cls` to show only classes, or `type=rtn` to show only routines.
-  - `flat=1` to flatten the hierarchy.
-  - `generated=1` to show generated items.
-  - `system=1` to show system (%) items. Without this parameter these are only shown for the %SYS namespace.
-  - `filter=filterspec` to use a filter specification formatted in the same way as used in InterSystems Studio's File Open dialog (e.g. `filter=Ensem*.inc`).
-
-## Support and Training
-
-[CaretDev](https://caretdev.com/#products) provides commercial support services. [Request a quote](https://caretdev.com/contact-us/).
-
-On-line course from CaretDev - [Developing with VS Code ObjectScript – Easy Start](https://caretdev.com/courses/).

docs/Configuration.md

@@ -5,6 +5,8 @@ permalink: /configuration/
 nav_order: 4
 ---
 
+> **Note:** This documentation has been moved to the [InterSystems Documentation site](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_config). This page will be removed at a later date.
+
 # Configuration
 
 VS Code settings enable you to customize various aspects of its behavior. The InterSystems extensions provide settings used to configure VS Code for ObjectScript development.

docs/ExtensionUI.md

@@ -5,6 +5,8 @@ permalink: /extensionui/
 nav_order: 3
 ---
 
+> **Note:** This documentation has been moved to the [InterSystems Documentation site](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_ui). This page will be removed at a later date.
+
 # InterSystems Extensions User Interface
 
 The InterSystems extensions add additional capability to the VS Code user interface to support development in ObjectScript. These additions are based on the standard VS Code UI, which is described in the section [User Interface](https://code.visualstudio.com/docs/getstarted/userinterface) in the VS Code documentation.

docs/Installation.md

@@ -4,6 +4,9 @@ title: Installation
 permalink: /installation/
 nav_order: 2
 ---
+
+> **Note:** This documentation has been moved to the [InterSystems Documentation site](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_install). This page will be removed at a later date.
+
 # Installation
 
 ## Install VS Code

docs/LowCode.md

@@ -5,6 +5,8 @@ permalink: /low-code/
 nav_order: 11
 ---
 
+> **Note:** This documentation has been moved to the [InterSystems Documentation site](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_lowcode). This page will be removed at a later date.
+
 # Low-Code Editors
 
 VS Code contains support for low-code editors via its [Custom Editors API](https://code.visualstudio.com/api/extension-guides/custom-editors). As InterSystems redevelops its suite of low-code editors for Interoperability components, support for integration with this extension will be included. This page lists the currently supported low-code editors and describes how to use them in VS Code.

docs/Projects.md

@@ -5,6 +5,8 @@ permalink: /projects/
 nav_order: 9
 ---
 
+> **Note:** This documentation has been moved to the [InterSystems Documentation site](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_project). This page will be removed at a later date.
+
 # Working with Projects
 
 A project is a named set of class definitions, routines, include files, web application files or custom documents. All files in a project must be in the same namespace on the same InterSystems server. Each document can be associated with any number of projects. Each namespace can contain any number of projects.

docs/ReportingIssues.md

@@ -5,9 +5,11 @@ permalink: /feedback/
 nav_order: 8
 ---
 
+> **Note:** This documentation has been moved to the [InterSystems Documentation site](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_reporting). This page will be removed at a later date.
+
 # 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:
+[InterSystems ObjectScript for VS Code](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO) 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...`.
 

docs/RunDebug.md

@@ -4,6 +4,9 @@ title: Running and Debugging
 permalink: /rundebug/
 nav_order: 5
 ---
+
+> **Note:** This documentation has been moved to the [InterSystems Documentation site](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_debug). This page will be removed at a later date.
+
 # Running and Debugging
 
 The InterSystems ObjectScript Extension provides support for ObjectScript debugging. It takes advantage of the debugging capabilities built into VS Code, so you may find these VS Code documentation resources useful:

docs/ServerSide.md

@@ -5,6 +5,8 @@ permalink: /serverside/
 nav_order: 6
 ---
 
+> **Note:** This documentation has been moved to the [InterSystems Documentation site](https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=GVSCO_ssworkflow). This page will be removed at a later date.
+
 # Server-side Editing 
 
 You can configure the InterSystems ObjectScript extension to edit code directly on the server, using the [multi-root workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces) VS Code feature. This type of configuration is useful in cases where source code is stored in a Source Code Management (SCM) product interfaced to the server. For example you might already be using the Source Control menu in InterSystems Studio or Portal, implemented by a source control class that extends `%Studio.SourceControl.Base`.