diff --git a/modules/administration-guide/partials/proc_adding-or-removing-extensions-in-the-embedded-open-vsx-registry-instance.adoc b/modules/administration-guide/partials/proc_adding-or-removing-extensions-in-the-embedded-open-vsx-registry-instance.adoc index ac2b28dab1..393ab20b8c 100644 --- a/modules/administration-guide/partials/proc_adding-or-removing-extensions-in-the-embedded-open-vsx-registry-instance.adoc +++ b/modules/administration-guide/partials/proc_adding-or-removing-extensions-in-the-embedded-open-vsx-registry-instance.adoc @@ -15,43 +15,58 @@ pass:[] .Procedure -include::example$snip_{project-context}-steps-to-add-or-remove-extensions-in-openvsx-sync-json.adoc[] +. Get the publisher and extension names of each chosen extension: + +.. Find the extension on the link:https://www.open-vsx.org/[Open VSX registry website] and copy the URL of the extension's listing page. -** If the extension is published on link:https://open-vsx.org[open-vsx.org], you can add its extension `id` in the format ____.____. You can find the `id` details on the extension's listing page on link:https://open-vsx.org[open-vsx.org]. +.. Extract the ____ and ____ names from the copied URL: + -[source,json,subs="+quotes"] +[subs="+quotes"] ---- - { - "id": "____.____" - } +https://www.open-vsx.org/extension/____/____ ---- + [TIP] ==== -The latest extension version on link:https://open-vsx.org[open-vsx.org] is the default. Alternatively, you can add `"version": "____"` on a new line to specify a version. + +If the extension is only available from link:https://marketplace.visualstudio.com/VSCode[Microsoft Visual Studio Marketplace], but not link:https://open-vsx.org[Open VSX], you can ask the extension publisher to also publish it on link:https://open-vsx.org[open-vsx.org] according to these link:https://github.com/eclipse/openvsx/wiki/Publishing-Extensions#how-to-publish-an-extension[instructions], potentially using this link:https://github.com/marketplace/actions/publish-vs-code-extension[GitHub action]. + +If the extension publisher is unavailable or unwilling to publish the extension to link:https://open-vsx.org[open-vsx.org], and if there is no Open VSX equivalent of the extension, consider link:https://github.com/open-vsx/publish-extensions/issues[reporting an issue] to the Open VSX team. + ==== -** If the extension is only available from link:https://marketplace.visualstudio.com/VSCode[Microsoft Visual Studio Marketplace], but not link:https://open-vsx.org[Open VSX], you can ask the extension publisher to also publish it on link:https://open-vsx.org[open-vsx.org] according to these link:https://github.com/eclipse/openvsx/wiki/Publishing-Extensions#how-to-publish-an-extension[instructions], potentially using this link:https://github.com/marketplace/actions/publish-vs-code-extension[GitHub action]. +include::example$snip_{project-context}-steps-to-add-or-remove-extensions-in-openvsx-sync-json.adoc[] + +** To add extensions, add the publisher and extension names to the `openvsx-sync.json` file. +** To remove extensions, remove the publisher and extension names from the `openvsx-sync.json` file. +** Use the following JSON syntax: ++ +[source,json,subs="+quotes"] +---- + { + "id": "____.____" + } +---- + [TIP] ==== -* If the extension publisher is unavailable or unwilling to publish the extension to link:https://open-vsx.org[open-vsx.org], and if there is no Open VSX equivalent of the extension, consider link:https://github.com/open-vsx/publish-extensions/issues[reporting an issue] to the Open VSX team. -* If you have a closed-source extension or an extension developed only for internal use in your company, you can add the extension directly from a `.vsix` file by using a URL accessible to your custom plugin registry container: +* The latest extension version on link:https://open-vsx.org[open-vsx.org] is the default. Alternatively, you can add `"version": "____"` on a new line to specify a version. + +* If you have a closed-source extension or an extension developed only for internal use in your organization, you can add the extension directly from a `.vsix` file by using a URL accessible to your custom plugin registry container: + [source,json,subs="+quotes"] ---- { - "id": "____.____", + "id": "____.____", "download": "____", "version": "____" } ---- -==== -+ -WARNING: Please read the link:https://aka.ms/vsmarketplace-ToU[Terms of Use] for the link:https://marketplace.visualstudio.com/VSCode[Microsoft Visual Studio Marketplace] before using its resources. -** You can remove the extension by deleting it from the `openvsx-sync.json` file. +* Read the link:https://aka.ms/vsmarketplace-ToU[Terms of Use] for the link:https://marketplace.visualstudio.com/VSCode[Microsoft Visual Studio Marketplace] before using its resources. + +==== . Build the plugin registry container image and publish it to a container registry like link:https://quay.io/[quay.io]: @@ -69,7 +84,7 @@ $ ./build.sh -o ____ -r quay.io -t custom $ {docker-cli} push quay.io/____ ---- -. Edit the `CheCluster` custom resource in your organization's cluster to point to the image (for example, on link:https://quay.io/[quay.io]) and then save the changes: +. Edit the `CheCluster` custom resource in your organization's cluster to point to the image (for example, on link:https://quay.io/[quay.io]) and save the changes: + [source,yaml,subs="+quotes"] ---- @@ -82,6 +97,8 @@ spec: openVSXURL: '' ---- +.Verification + . Check that the `plugin-registry` pod has restarted and is running. . Restart the workspace and check the available extensions in the *Extensions* view of the workspace IDE. diff --git a/modules/administration-guide/partials/proc_selecting-an-open-vsx-registry-instance.adoc b/modules/administration-guide/partials/proc_selecting-an-open-vsx-registry-instance.adoc index 12d23acb53..a55991c76e 100644 --- a/modules/administration-guide/partials/proc_selecting-an-open-vsx-registry-instance.adoc +++ b/modules/administration-guide/partials/proc_selecting-an-open-vsx-registry-instance.adoc @@ -23,7 +23,7 @@ spec: ==== * The default `openVSXURL` value is `pass:c,a,q[https://open-vsx.org]`. -* To select the embedded Open VSX registry instance in the `plugin-registry` pod, use `openVSXURL: ''`. See the next section for how to customize the included extensions. +* To select the embedded Open VSX registry instance in the `plugin-registry` pod, use `openVSXURL: ''`. See the next section for how to customize the list of included extensions. * You can also point `openVSXURL` at the URL of a standalone Open VSX registry instance if its URL is accessible from within your organization's cluster and not blocked by a proxy. ==== diff --git a/modules/end-user-guide/nav.adoc b/modules/end-user-guide/nav.adoc index 06d9e7dc88..85a9d1ee5b 100644 --- a/modules/end-user-guide/nav.adoc +++ b/modules/end-user-guide/nav.adoc @@ -9,7 +9,7 @@ ** xref:starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc[] ** xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[] *** xref:url-parameter-concatenation.adoc[] -*** xref:url-parameter-for-the-workspace-ide.adoc[] +*** xref:url-parameter-for-the-ide.adoc[] *** xref:url-parameter-for-starting-duplicate-workspaces.adoc[] *** xref:url-parameter-for-the-devfile-file-name.adoc[] *** xref:url-parameter-for-the-devfile-file-path.adoc[] @@ -19,9 +19,9 @@ ** xref:authenticating-to-a-git-server-from-a-workspace.adoc[] * xref:customizing-workspace-components.adoc[] * xref:devfile-introduction.adoc[] -* xref:selecting-a-workspace-ide.adoc[] -** xref:selecting-an-in-browser-ide-for-one-new-workspace.adoc[] -** xref:selecting-an-in-browser-ide-for-all-workspaces-that-clone-the-same-git-repository.adoc[] +* xref:ides-in-workspaces.adoc[] +** xref:defining-a-common-ide.adoc[] +** xref:microsoft-visual-studio-code-open-source-ide.adoc[] * xref:using-credentials-and-configurations-in-workspaces.adoc[] ** xref:mounting-secrets.adoc[] *** xref:creating-image-pull-secrets.adoc[] diff --git a/modules/end-user-guide/pages/customizing-workspace-components.adoc b/modules/end-user-guide/pages/customizing-workspace-components.adoc index 529042f273..26f6851a0f 100644 --- a/modules/end-user-guide/pages/customizing-workspace-components.adoc +++ b/modules/end-user-guide/pages/customizing-workspace-components.adoc @@ -12,8 +12,8 @@ To customize workspace components: * xref:starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc[Choose a Git repository for your workspace]. -* xref:devfile-introduction.adoc[Use a devfile] +* xref:devfile-introduction.adoc[Use a devfile]. -* xref:selecting-a-workspace-ide.adoc[Select and customize your in-browser IDE]. +* xref:ides-in-workspaces.adoc[Configure an IDE]. * Add {prod-short} specific attributes in addition to the generic devfile specification. diff --git a/modules/end-user-guide/pages/defining-a-common-ide.adoc b/modules/end-user-guide/pages/defining-a-common-ide.adoc new file mode 100644 index 0000000000..e8d5be354d --- /dev/null +++ b/modules/end-user-guide/pages/defining-a-common-ide.adoc @@ -0,0 +1,17 @@ +:_content-type: PROCEDURE +:navtitle : Defining a common IDE +:description: Defining a common IDE +:keywords: select-IDE, che-editor, che-editor-yaml +:page-aliases: specifying-an-in-browser-ide-for-a-git-repository-by-using-che-editor.yaml.adoc, selecting-an-in-browser-ide-for-all-workspaces-that-clone-the-same-git-repository.adoc + +[id="defining-a-common-ide"] += Defining a common IDE + +While the xref:url-parameter-for-the-ide.adoc[URL parameter for the IDE] enables you to start a workspace with your personal choice of the supported IDE, you might find it more convenient to define the same IDE for all workspaces for the same source code Git repository. To do so, use the `che-editor.yaml` file. This file supports even a detailed IDE configuration. + +TIP: If you intend to start most or all of your organization's workspaces with the same IDE other than Microsoft Visual Studio Code - Open Source, an alternative is for the administrator of your organization's {prod-short} instance to specify another supported IDE as the default IDE at the {prod-short} instance level. This can be done with `.spec.devEnvironments.defaultEditor` in the `CheCluster` Custom Resource. + +include::partial$proc_setting-up-che-editor-yaml.adoc[leveloffset=+1] + +include::partial$ref_parameters-for-che-editor-yaml.adoc[leveloffset=+1] + diff --git a/modules/end-user-guide/pages/ides-in-workspaces.adoc b/modules/end-user-guide/pages/ides-in-workspaces.adoc new file mode 100644 index 0000000000..cc5da18f4f --- /dev/null +++ b/modules/end-user-guide/pages/ides-in-workspaces.adoc @@ -0,0 +1,30 @@ +:_content-type: PROCEDURE +:description: IDEs in workspaces +:keywords: configuring, workspace, editor, ide, cloud ide +:navtitle: IDEs in workspaces +:page-aliases: + +[id="ides-in-workspaces"] += IDEs in workspaces + +== Supported IDEs + +The default IDE in a new workspace is Microsoft Visual Studio Code - Open Source. Alternatively, you can choose another supported IDE: + +.Supported IDEs + +[cols="1,1a,1a"] +|=== +| IDE | `id` | Note + +include::example$snip_{project-context}-table-of-supported-editors.adoc[] + +|=== + +== Repository-level IDE configuration in {prod-short} + +You can store IDE configuration files directly in the remote Git repository that contains your project source code. This way, one common IDE configuration is applied to all new workspaces that feature a clone of that repository. Such IDE configuration files might include the following: + +* xref:defining-a-common-ide.adoc[The `/.che/che-editor.yaml` file] that stores a definition of the chosen IDE. + +* IDE-specific configuration files that one would typically store locally for a desktop IDE. For example, xref:microsoft-visual-studio-code-open-source-ide.adoc[the `/.vscode/extensions.json` file.] diff --git a/modules/end-user-guide/pages/microsoft-visual-studio-code-open-source-ide.adoc b/modules/end-user-guide/pages/microsoft-visual-studio-code-open-source-ide.adoc new file mode 100644 index 0000000000..a46826c27b --- /dev/null +++ b/modules/end-user-guide/pages/microsoft-visual-studio-code-open-source-ide.adoc @@ -0,0 +1,31 @@ +:_content-type: CONCEPT +:description: Microsoft Visual Studio Code - Open Source IDE +:keywords: user-guide, selecting, IDE, select, selecting, editor, ide, vs-code, visual-studio, visual-studio-code, jetbrains, intellij, pycharm, theia, che-theia +:navtitle: Microsoft Visual Studio Code - Open Source +:page-aliases: + +[id="microsoft-visual-studio-code-open-source-ide"] += Microsoft Visual Studio Code - Open Source IDE + +The {prod-short} build of link:https://github.com/microsoft/vscode[Microsoft Visual Studio Code - Open Source] is the default IDE of a new workspace. + +You can automate installation of Microsoft Visual Studio Code extensions from the xref:administration-guide:extensions-for-microsoft-visual-studio-code-open-source.adoc[Open VSX registry] at workspace startup. See _Automating installation of Microsoft Visual Studio Code extensions at workspace startup_. + +[TIP] +==== + +* Use link:https://code.visualstudio.com/Docs/editor/tasks[Tasks] to find and run the commands specified in `devfile.yaml`. + +* Use *{prod2}* commands by clicking *{prod2}* in the link:https://code.visualstudio.com/api/ux-guidelines/status-bar[Status Bar] or finding them through the link:https://code.visualstudio.com/api/ux-guidelines/command-palette[Command Palette]: + +** *{prod2}: Open Dashboard* +** *{prod2}: Stop Workspace* +** *{prod2}: Restart Workspace* +** *{prod2}: Restart Workspace from Local Devfile* +** *{prod2}: Open Documentation* + +==== + +NOTE: You might see your organization's branding in this IDE if your organization customized it through a branded build. + +include::partial$proc_automating-installation-of-microsoft-visual-studio-code-extensions-at-workspace-startup.adoc[leveloffset=+1] diff --git a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc index 90478cd183..c511617ac9 100644 --- a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc +++ b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc @@ -10,7 +10,7 @@ When you start a new workspace, {prod-short} configures the workspace according to the instructions in the devfile. When you use a URL to start a new workspace, you can append optional parameters to the URL that further configure the workspace. You can use these parameters to specify a workspace IDE, start duplicate workspaces, and specify a devfile file name or path. * xref:url-parameter-concatenation.adoc[] -* xref:url-parameter-for-the-workspace-ide.adoc[] +* xref:url-parameter-for-the-ide.adoc[] * xref:url-parameter-for-starting-duplicate-workspaces.adoc[] * xref:url-parameter-for-the-devfile-file-name.adoc[] * xref:url-parameter-for-the-devfile-file-path.adoc[] diff --git a/modules/end-user-guide/pages/selecting-a-workspace-ide.adoc b/modules/end-user-guide/pages/selecting-a-workspace-ide.adoc deleted file mode 100644 index a325954733..0000000000 --- a/modules/end-user-guide/pages/selecting-a-workspace-ide.adoc +++ /dev/null @@ -1,27 +0,0 @@ -:_content-type: CONCEPT -:description: Selecting a workspace IDE -:keywords: user-guide, selecting, IDE, select, selecting, editor, ide, vs-code, visual-studio, visual-studio-code, jetbrains, intellij, pycharm, theia, che-theia -:navtitle: Selecting a workspace IDE -:page-aliases: - -[id="selecting-a-workspace-ide"] -= Selecting a workspace IDE - -The default in-browser IDE in a new workspace is Microsoft Visual Studio Code - Open Source. - -NOTE: Because the {prod-short} build of Microsoft Visual Studio Code - Open Source supports custom branding, your organization might be using a branded build. - -You can select another supported in-browser IDE by either method: - -* When you start a new workspace by visiting a URL, you can choose an IDE for that workspace by adding the `che-editor` parameter to the URL. See xref:selecting-an-in-browser-ide-for-one-new-workspace.adoc[]. -* You can specify an IDE in the `.che/che-editor.yaml` file of the Git repository for all new workspaces that will feature a clone of that repository. See xref:selecting-an-in-browser-ide-for-all-workspaces-that-clone-the-same-git-repository.adoc[]. - -.Supported in-browser IDEs - -[cols="1,1a,1a"] -|=== -| IDE | `id` | Note - -include::example$snip_{project-context}-table-of-supported-editors.adoc[] - -|=== diff --git a/modules/end-user-guide/pages/selecting-an-in-browser-ide-for-all-workspaces-that-clone-the-same-git-repository.adoc b/modules/end-user-guide/pages/selecting-an-in-browser-ide-for-all-workspaces-that-clone-the-same-git-repository.adoc deleted file mode 100644 index 8adc5e10fe..0000000000 --- a/modules/end-user-guide/pages/selecting-an-in-browser-ide-for-all-workspaces-that-clone-the-same-git-repository.adoc +++ /dev/null @@ -1,13 +0,0 @@ -:_content-type: PROCEDURE -:navtitle: Selecting an in-browser IDE for all workspaces that clone the same Git repository -:description: Selecting an in-browser IDE for all workspaces that clone the same Git repository -:keywords: select-IDE, che-editor, che-editor-yaml -:page-aliases: specifying-an-in-browser-ide-for-a-git-repository-by-using-che-editor.yaml.adoc - -[id="selecting-an-in-browser-ide-for-all-workspaces-that-clone-the-same-git-repository"] -= Selecting an in-browser IDE for all workspaces that clone the same Git repository - -include::partial$proc_setting-up-che-editor-yaml.adoc[leveloffset=+1] - -include::partial$ref_parameters-for-che-editor-yaml.adoc[leveloffset=+1] - diff --git a/modules/end-user-guide/pages/selecting-an-in-browser-ide-for-one-new-workspace.adoc b/modules/end-user-guide/pages/selecting-an-in-browser-ide-for-one-new-workspace.adoc deleted file mode 100644 index 9d492cd2a0..0000000000 --- a/modules/end-user-guide/pages/selecting-an-in-browser-ide-for-one-new-workspace.adoc +++ /dev/null @@ -1,18 +0,0 @@ -:_content-type: PROCEDURE -:description: Selecting an in-browser IDE for one new workspace -:keywords: select-IDE -:navtitle: Selecting an in-browser IDE for one new workspace -:page-aliases: selecting-an-ide-by-using-a-url-parameter.adoc - -[id="selecting-an-in-browser-ide-for-one-new-workspace"] -= Selecting an in-browser IDE for one new workspace - -You can select your preferred in-browser IDE when using a URL for starting a new workspace. This way, each developer using {prod-short} can start a workspace with a clone of the same project repository and the personal choice of the in-browser IDE. - -.Procedure - -. Include the xref:url-parameter-for-the-workspace-ide.adoc[URL parameter for the workspace IDE] in the xref:starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc[URL for starting a new workspace]. -. Visit the URL in the browser. - -.Verification -* Verify that the selected in-browser IDE loads in the browser tab of the started workspace. diff --git a/modules/end-user-guide/pages/url-parameter-for-the-ide.adoc b/modules/end-user-guide/pages/url-parameter-for-the-ide.adoc new file mode 100644 index 0000000000..aa4723878d --- /dev/null +++ b/modules/end-user-guide/pages/url-parameter-for-the-ide.adoc @@ -0,0 +1,50 @@ +:_content-type: CONCEPT +:description: URL parameter for the IDE +:keywords: ide, editor, workspace-ide, workspace-editor +:navtitle: URL parameter for the IDE +:page-aliases: url-parameter-for-the-in-browser-ide.adoc + +[id="url-parameter-for-the-ide"] += URL parameter for the IDE + +You can use the `che-editor=` URL parameter to specify a supported IDE when starting a workspace. + +TIP: Use the `che-editor=` parameter when you cannot add or edit a xref:defining-a-common-ide.adoc[`/.che/che-editor.yaml`] file in the source-code Git repository to be cloned for workspaces. + +NOTE: The `che-editor=` parameter overrides the xref:defining-a-common-ide.adoc[`/.che/che-editor.yaml`] file. + +This parameter accepts two types of values: + +* `che-editor=____` ++ +[source,subs="+quotes,+attributes,+macros"] +---- +pass:c,a,q[{prod-url}]#____?che-editor=____ +---- ++ + +.The URL parameter `____` values for supported IDEs +[cols="1,1a,1a"] +|=== +| IDE | `____` value | Note + +include::example$snip_{project-context}-table-of-supported-editors.adoc[] + +|=== + +* `che-editor=____` ++ +[source,subs="+quotes,+attributes,+macros"] +---- +pass:c,a,q[{prod-url}]#____?che-editor=____# <1> +---- +<1> URL to a file with link:https://devfile.io/docs/2.2.0/what-is-a-devfile[devfile content]. ++ +[TIP] +==== + +* The URL must point to the raw file content. + +* To use this parameter with a xref:defining-a-common-ide.adoc[`che-editor.yaml`] file, copy the file with another name or path, and remove the line with `inline` from the file. + +==== diff --git a/modules/end-user-guide/pages/url-parameter-for-the-workspace-ide.adoc b/modules/end-user-guide/pages/url-parameter-for-the-workspace-ide.adoc deleted file mode 100644 index a3029df46f..0000000000 --- a/modules/end-user-guide/pages/url-parameter-for-the-workspace-ide.adoc +++ /dev/null @@ -1,29 +0,0 @@ -:_content-type: CONCEPT -:description: URL parameter for the workspace IDE -:keywords: ide, editor, workspace-ide, workspace-editor -:navtitle: URL parameter for the workspace IDE -:page-aliases: - -[id="url-parameter-for-the-workspace-ide"] -= URL parameter for the workspace IDE - -If the URL for starting a new workspace doesn't contain a URL parameter specifying the integrated development environment (IDE), the workspace loads with the default in-browser IDE, which is Microsoft Visual Studio Code - Open Source. - -The URL parameter for specifying another supported IDE is `che-editor=____`: - -[source,subs="+quotes,+attributes,+macros"] ----- -pass:c,a,q[{prod-url}]#____?che-editor=____ ----- - -NOTE: The workspace IDE might be already set for a remote Git repository in the xref:selecting-an-in-browser-ide-for-all-workspaces-that-clone-the-same-git-repository.adoc[`che-editor.yaml` file of the repository]. - -.The URL parameter `____` values for supported IDEs - -[cols="1,1a,1a"] -|=== -| IDE | `____` value | Note - -include::example$snip_{project-context}-table-of-supported-editors.adoc[] - -|=== diff --git a/modules/end-user-guide/partials/proc_automating-installation-of-microsoft-visual-studio-code-extensions-at-workspace-startup.adoc b/modules/end-user-guide/partials/proc_automating-installation-of-microsoft-visual-studio-code-extensions-at-workspace-startup.adoc new file mode 100644 index 0000000000..40711296c1 --- /dev/null +++ b/modules/end-user-guide/partials/proc_automating-installation-of-microsoft-visual-studio-code-extensions-at-workspace-startup.adoc @@ -0,0 +1,58 @@ + +[id="automating-installation-of-microsoft-visual-studio-code-extensions-at-workspace-startup"] += Automating installation of Microsoft Visual Studio Code extensions at workspace startup + +To have the Microsoft Visual Studio Code - Open Source IDE automatically install chosen extensions, you can add an `extensions.json` file to the remote Git repository that contains your project source code and that will be cloned into workspaces. + +.Prerequisites +* {prod-short} has network access to the link:https://www.open-vsx.org/[OpenVSX registry]. ++ +[TIP] +==== +To install recommended extensions in a restricted environment, consider these options: + +* xref:administration-guide:configuring-the-open-vsx-registry-url.adoc[] to point to your OpenVSX registry. + +* xref:defining-a-common-ide.adoc[]. + +* link:https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix[Installing extensions from VSX files]. +==== + +.Procedure + +. Get the publisher and extension names of each chosen extension: + +.. Find the extension on the link:https://www.open-vsx.org/[Open VSX registry website] and copy the URL of the extension's listing page. + +.. Extract the ____ and ____ names from the copied URL: ++ +[subs="+quotes"] +---- +https://www.open-vsx.org/extension/____/____ +---- + +. Create a `.vscode/extensions.json` file in the remote Git repository. + +. Add the ____ and ____ names to the `extensions.json` file as follows: ++ +[source,json,subs="+quotes"] +---- + { + "recommendations": [ + "____.____", + "____.____", + "____.____" + ] + } +---- + +.Verification + +. xref:starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc[Start a new workspace by using the URL of the remote Git repository] that contains the created `extensions.json` file. +. In the IDE of the workspace, press kbd:[Ctrl+Shift+X] or go to *Extensions* to find each of the extensions listed in the file. +. The extension has the label *This extension is enabled globally*. + +.Additional resources +* link:https://www.open-vsx.org/[Open VSX registry - Extensions for Microsoft Visual Studio Code compatible editors] +* link:https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions[Microsoft Visual Studio Code - Workspace recommended extensions] + diff --git a/modules/end-user-guide/partials/proc_setting-up-che-editor-yaml.adoc b/modules/end-user-guide/partials/proc_setting-up-che-editor-yaml.adoc index 6f8c4585d0..c41b23770f 100644 --- a/modules/end-user-guide/partials/proc_setting-up-che-editor-yaml.adoc +++ b/modules/end-user-guide/partials/proc_setting-up-che-editor-yaml.adoc @@ -1,16 +1,14 @@ [id="setting-up-che-editor-yaml"] = Setting up che-editor.yaml -To define the same in-browser IDE for all workspaces that will clone the same remote Git repository of your project, you can use the `che-editor.yaml` file. - -This way, you can set a common default editor for your team and provide new contributors with the most suitable editor for your project. You can also use the `che-editor.yaml` file when you need to set a different IDE default for a particular project repository rather than the default IDE of your organization's {prod-short} instance. +By using the `che-editor.yaml` file, you can set a common default IDE for your team and provide new contributors with the most suitable IDE for your project source code. You can also use the `che-editor.yaml` file when you need to set a different IDE default for a particular source code Git repository rather than the default IDE of your organization's {prod-short} instance. .Procedure -* In the remote Git repository of your project, create a `/.che/che-editor.yaml` file with lines that specify the relevant parameter, as described in the next section. +* In the remote Git repository of your project source code, create a `/.che/che-editor.yaml` file with lines that specify the relevant parameter, as described in the next section. .Verification -. Visit the xref:starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc[URL for starting a new workspace]. -. Verify that the selected in-browser IDE loads in the browser tab of the started workspace. +. xref:starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc[Start a new workspace with a clone of the Git repository]. +. Verify that the specified IDE loads in the browser tab of the started workspace. diff --git a/modules/end-user-guide/partials/ref_parameters-for-che-editor-yaml.adoc b/modules/end-user-guide/partials/ref_parameters-for-che-editor-yaml.adoc index efff1da492..6cfc2ccf4c 100644 --- a/modules/end-user-guide/partials/ref_parameters-for-che-editor-yaml.adoc +++ b/modules/end-user-guide/partials/ref_parameters-for-che-editor-yaml.adoc @@ -1,7 +1,17 @@ [id="parameters-for-che-editor-yaml"] = Parameters for che-editor.yaml -The simplest way to select an IDE in the `che-editor.yaml` is to specify the `id` of an IDE that is available in the table of supported in-browser IDEs in xref:selecting-a-workspace-ide.adoc[]: +The simplest way to select an IDE in the `che-editor.yaml` is to specify the `id` of an IDE from the table of supported IDEs: + +.Supported IDEs +[cols="1,1a,1a"] +|=== +| IDE | `id` | Note + +include::example$snip_{project-context}-table-of-supported-editors.adoc[] + +|=== + .`id` selects an IDE from the plugin registry ====