-
Notifications
You must be signed in to change notification settings - Fork 164
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Robert Krátký
committed
Jul 28, 2019
1 parent
d8baeb7
commit 01663e0
Showing
19 changed files
with
118 additions
and
419 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file removed
BIN
-126 KB
src/main/images/extensibility/adding_the_vs_code_extension_changeRegistry.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+72.1 KB
src/main/images/extensibility/vs-code-extension-restart-workspace.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed
BIN
-108 KB
src/main/images/extensibility/vs_code_extension_procedure1_installation.png
Binary file not shown.
Binary file removed
BIN
-107 KB
src/main/images/extensibility/vs_code_extension_procedure2_apply_restart.png
Binary file not shown.
Binary file removed
BIN
-113 KB
src/main/images/extensibility/vs_code_extension_procedure3_restartWorkspace.png
Binary file not shown.
57 changes: 0 additions & 57 deletions
57
...ance/assembly_adding-che-plug-in-registry-vs-code-extension-to-a-workspace.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,71 +1,14 @@ | ||
// This assembly is included in the following assemblies: | ||
// | ||
// publishing-a-vs-code-extension-into-the-che-plug-in-registry | ||
|
||
// This assembly can be included from other assemblies using the following | ||
// include statement: | ||
// include::<path>/assembly_adding-che-plug-in-registry-vs-code-extension-to-a-workspace.adoc[leveloffset=+1] | ||
|
||
// The following line is necessary to allow assemblies be included in other | ||
// assemblies. It restores the `context` variable to its previous state. | ||
:parent-context-of-adding-che-plug-in-registry-vs-code-extension-to-a-workspace: {context} | ||
|
||
// The file name and the ID are based on the assembly title. | ||
// For example: | ||
// * file name: assembly_my-assembly-a.adoc | ||
// * ID: [id='assembly_my-assembly-a_{context}'] | ||
// * Title: = My assembly A | ||
// | ||
// The ID is used as an anchor for linking to the module. | ||
// Avoid changing it after the module has been published | ||
// to ensure existing links are not broken. | ||
// | ||
// In order for the assembly to be reusable in other assemblies in a guide, | ||
// include {context} in the ID: [id='a-collection-of-modules_{context}']. | ||
// | ||
// If the assembly covers a task, start the title with a verb in the gerund | ||
// form, such as Creating or Configuring. | ||
[id='adding-che-plug-in-registry-vs-code-extension-to-a-workspace_{context}'] | ||
= Adding plug-in registry VS Code extension to a workspace | ||
|
||
// The `context` attribute enables module reuse. Every module's ID | ||
// includes {context}, which ensures that the module has a unique ID even if | ||
// it is reused multiple times in a guide. | ||
:context: adding-che-plug-in-registry-vs-code-extension-to-a-workspace | ||
|
||
// The following block is rendered only if the `internal` variable is set. | ||
// The table shows various metadata useful when editing this file. | ||
ifdef::internal[] | ||
[cols="1,4"] | ||
|=== | ||
| Included in | | ||
LIST OF ASSEMBLIES | ||
| User story | | ||
USER STORY | ||
| Jira | | ||
JIRA LINK | ||
| BZ | | ||
BUGZILLA LINK | ||
| SMEs | | ||
SME NAMES | ||
| SME Ack | | ||
YES/NO | ||
| Peer Ack | | ||
YES/NO | ||
|=== | ||
endif::[] | ||
|
||
When the required VS Code extension is added into a Che plug-in registry, the user can add it into the workspace through the *Che Plugins* panel or through the workspace configuration. | ||
|
||
// The following include statements pull in the module files that comprise | ||
// the assembly. Include any combination of concept, procedure, or reference | ||
// modules required to cover the user story. You can also include other | ||
// assemblies. | ||
|
||
include::proc_adding-the-vs-code-extension-using-the-che-plugins-panel.adoc[leveloffset=+1] | ||
|
||
include::proc_adding-the-vs-code-extension-using-the-workspace-configuration.adoc[leveloffset=+1] | ||
|
||
// The following line is necessary to allow assemblies be included in other | ||
// assemblies. It restores the `context` variable to its previous state. | ||
:context: {parent-context-of-adding-che-plug-in-registry-vs-code-extension-to-a-workspace} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
57 changes: 1 addition & 56 deletions
57
...ance/assembly_publishing-a-vs-code-extension-into-the-che-plug-in-registry.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,68 +1,13 @@ | ||
// This assembly is included in the following assemblies: | ||
// | ||
// using-a-visual-studio-code-extension-in-che | ||
|
||
// This assembly can be included from other assemblies using the following | ||
// include statement: | ||
// include::<path>/assembly_publishing-a-vs-code-extension-into-the-che-plug-in-registry.adoc[leveloffset=+1] | ||
|
||
// The following line is necessary to allow assemblies be included in other | ||
// assemblies. It restores the `context` variable to its previous state. | ||
:parent-context-of-publishing-a-vs-code-extension-into-the-che-plug-in-registry: {context} | ||
|
||
// The file name and the ID are based on the assembly title. | ||
// For example: | ||
// * file name: assembly_my-assembly-a.adoc | ||
// * ID: [id='assembly_my-assembly-a_{context}'] | ||
// * Title: = My assembly A | ||
// | ||
// The ID is used as an anchor for linking to the module. | ||
// Avoid changing it after the module has been published | ||
// to ensure existing links are not broken. | ||
// | ||
// In order for the assembly to be reusable in other assemblies in a guide, | ||
// include {context} in the ID: [id='a-collection-of-modules_{context}']. | ||
// | ||
// If the assembly covers a task, start the title with a verb in the gerund | ||
// form, such as Creating or Configuring. | ||
[id='publishing-a-vs-code-extension-into-the-che-plug-in-registry_{context}'] | ||
= Publishing a VS Code extension into the Che plug-in registry | ||
|
||
// The `context` attribute enables module reuse. Every module's ID | ||
// includes {context}, which ensures that the module has a unique ID even if | ||
// it is reused multiple times in a guide. | ||
:context: publishing-a-vs-code-extension-into-the-che-plug-in-registry | ||
|
||
// The following block is rendered only if the `internal` variable is set. | ||
// The table shows various metadata useful when editing this file. | ||
ifdef::internal[] | ||
[cols="1,4"] | ||
|=== | ||
| Included in | | ||
LIST OF ASSEMBLIES | ||
| User story | | ||
USER STORY | ||
| Jira | | ||
JIRA LINK | ||
| BZ | | ||
BUGZILLA LINK | ||
| SMEs | | ||
SME NAMES | ||
| SME Ack | | ||
YES/NO | ||
| Peer Ack | | ||
YES/NO | ||
|=== | ||
endif::[] | ||
|
||
// PUT SOME INTRO HERE | ||
To set up a custom plug-in registry, see the link:https://docs.google.com/document/d/1K4pax-mmnOs98OXE7TcmzA0Kp0oo7AnjdAq6iFf7x0k/edit#heading=h.12z5y7kdgm0z[Registries Customization] article. | ||
To set up a custom plug-in registry, see the link:TODO[Registries customization] article. | ||
|
||
include::proc_writing-a-meta-yaml-file-and-adding-it-to-a-plug-in-registry.adoc[leveloffset=+1] | ||
|
||
include::assembly_adding-che-plug-in-registry-vs-code-extension-to-a-workspace.adoc[leveloffset=+1] | ||
|
||
|
||
// The following line is necessary to allow assemblies be included in other | ||
// assemblies. It restores the `context` variable to its previous state. | ||
:context: {parent-context-of-publishing-a-vs-code-extension-into-the-che-plug-in-registry} |
78 changes: 10 additions & 68 deletions
78
...e-7/hands-on-guidance/assembly_using-a-visual-studio-code-extension-in-che.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,87 +1,29 @@ | ||
// This assembly is included in the following assemblies: | ||
// | ||
// <List assemblies here, each on a new line> | ||
|
||
// This assembly can be included from other assemblies using the following | ||
// include statement: | ||
// include::<path>/assembly_using-a-visual-studio-code-extension-in-che.adoc[leveloffset=+1] | ||
|
||
// The following line is necessary to allow assemblies be included in other | ||
// assemblies. It restores the `context` variable to its previous state. | ||
:parent-context-of-using-a-visual-studio-code-extension-in-che: {context} | ||
|
||
// The file name and the ID are based on the assembly title. | ||
// For example: | ||
// * file name: assembly_my-assembly-a.adoc | ||
// * ID: [id='assembly_my-assembly-a_{context}'] | ||
// * Title: = My assembly A | ||
// | ||
// The ID is used as an anchor for linking to the module. | ||
// Avoid changing it after the module has been published | ||
// to ensure existing links are not broken. | ||
// | ||
// In order for the assembly to be reusable in other assemblies in a guide, | ||
// include {context} in the ID: [id='a-collection-of-modules_{context}']. | ||
// | ||
// If the assembly covers a task, start the title with a verb in the gerund | ||
// form, such as Creating or Configuring. | ||
[id='using-a-visual-studio-code-extension-in-che_{context}'] | ||
= Using a Visual Studio Code extension in Che | ||
|
||
// The `context` attribute enables module reuse. Every module's ID | ||
// includes {context}, which ensures that the module has a unique ID even if | ||
// it is reused multiple times in a guide. | ||
:context: using-a-visual-studio-code-extension-in-che | ||
|
||
// The following block is rendered only if the `internal` variable is set. | ||
// The table shows various metadata useful when editing this file. | ||
ifdef::internal[] | ||
[cols="1,4"] | ||
|=== | ||
| Included in | | ||
LIST OF ASSEMBLIES | ||
| User story | | ||
USER STORY | ||
| Jira | | ||
JIRA LINK | ||
| BZ | | ||
BUGZILLA LINK | ||
| SMEs | | ||
SME NAMES | ||
| SME Ack | | ||
YES/NO | ||
| Peer Ack | | ||
YES/NO | ||
|=== | ||
endif::[] | ||
|
||
Starting with Eclipse Che 7, VisualStudio Code extensions can be installed to extend the functionality of a Che workspace. VS Code extension can run in the Che editor container, or they can be packaged in their own isolated and pre-configured containers with their prerequisites. | ||
Starting with Eclipse Che 7, Visual Studio Code (VS Code) extensions can be installed to extend the functionality of a Che workspace. VS Code extensions can run in the Che-Theia editor container, or they can be packaged in their own isolated and pre-configured containers with their prerequisites. | ||
|
||
This document describes the usage of the VS Code extension in Che with workspaces Che Plugins panel and how you can publish the VS Code extension in a plug-in registry. By doing so, you can share the extension with other Che users. Note that the extension hosting sidecar container and the use of the extension in a devfile are optional for this. | ||
|
||
In addition, you can review the compatibility of the VS Code extensions so that you can be informed whether a specific API is supported or has not been implemented yet. | ||
// The following include statements pull in the module files that comprise | ||
// the assembly. Include any combination of concept, procedure, or reference | ||
// modules required to cover the user story. You can also include other | ||
// assemblies. | ||
This document describes: | ||
|
||
* Use of a VS Code extension in Che with workspaces | ||
* Che Plug-ins panel | ||
* How to publish a VS Code extension in the Che plug-in registry (to share the extension with other Che users) | ||
+ | ||
** The extension-hosting sidecar container and the use of the extension in a devfile are optional for this. | ||
** How to review the compatibility of the VS Code extensions to be informed whether a specific API is supported or has not been implemented yet. | ||
|
||
include::proc_importing-a-vs-code-extension-in-the-che-theia-editor.adoc[leveloffset=+1] | ||
|
||
include::assembly_publishing-a-vs-code-extension-into-the-che-plug-in-registry.adoc[leveloffset=+1] | ||
|
||
include::assembly_adding-che-plug-in-registry-vs-code-extension-to-a-workspace.adoc[leveloffset=+1] | ||
|
||
include::proc_choosing-the-sidecar-image.adoc[leveloffset=+1] | ||
|
||
include::proc_verifying-the-vs-code-extension-api-compatibility-level.adoc[leveloffset=+1] | ||
|
||
// include::modules/subsystem/proc_doing_one_procedure.adoc[leveloffset=+1] | ||
|
||
// [leveloffset=+1] ensures that when a module starts with a level-1 heading | ||
// (= Heading), the heading will be interpreted as a level-2 heading | ||
// (== Heading) in the assembly. | ||
|
||
|
||
|
||
// The following line is necessary to allow assemblies be included in other | ||
// assemblies. It restores the `context` variable to its previous state. | ||
:context: {parent-context-of-using-a-visual-studio-code-extension-in-che} |
33 changes: 5 additions & 28 deletions
33
...-on-guidance/proc_adding-the-vs-code-extension-using-the-che-plugins-panel.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,40 +1,17 @@ | ||
// Module included in the following assemblies: | ||
// | ||
// adding-che-plug-in-registry-vs-code-extension-to-a-workspace | ||
|
||
// This module can be included from assemblies using the following include statement: | ||
// include::<path>/proc_adding-the-vs-code-extension-using-the-che-plugins-panel.adoc[leveloffset=+1] | ||
|
||
// The file name and the ID are based on the module title. For example: | ||
// * file name: proc_doing-procedure-a.adoc | ||
// * ID: [id='proc_doing-procedure-a_{context}'] | ||
// * Title: = Doing procedure A | ||
// | ||
// The ID is used as an anchor for linking to the module. Avoid changing | ||
// it after the module has been published to ensure existing links are not | ||
// broken. | ||
// | ||
// The `context` attribute enables module reuse. Every module's ID includes | ||
// {context}, which ensures that the module has a unique ID even if it is | ||
// reused multiple times in a guide. | ||
// | ||
// Start the title with a verb, such as Creating or Create. See also | ||
// _Wording of headings_ in _The IBM Style Guide_. | ||
[id="adding-the-vs-code-extension-using-the-che-plugins-panel_{context}"] | ||
= Adding the VS Code extension using the Che Plugins panel | ||
|
||
[discrete] | ||
== Procedure | ||
.Procedure | ||
|
||
To add the VS Code extension using the *Che Plugin* panel, follow the procedure below. | ||
To add the VS Code extension using the *Che Plugin* panel: | ||
|
||
. Open the *Che Plugin* panel. | ||
|
||
. Change the current registry to the registry in which the VS Code extension was added. | ||
|
||
. In the search bar, click the *Menu* button and then click *Change Registry* to choose the registry from the list. If the required registry is not in the list, add it using the *Add Registry* menu option. The registry link should point to the `plug-ins` segment of the registry. See an example: `https://my-registry.com/v3/plugins/index.json`. | ||
. In the search bar, click the *Menu* button and then click *Change Registry* to choose the registry from the list. If the required registry is not in the list, add it using the *Add Registry* menu option. The registry link should point to the `plugins` segment of the registry. For example: `https://my-registry.com/v3/plugins/index.json`. | ||
+ | ||
image::extensibility/adding_the_vs_code_extension_changeRegistry.png[] | ||
image::extensibility/vs-code-extension-change-registry.jpg[link="{imagesdir}/extensibility/vs-code-extension-change-registry.jpg"] | ||
|
||
. Search for the required plug-in using the filter and then click the btn:[Install] button. | ||
. Search for the required plug-in using the filter, and then click the btn:[Install] button. | ||
. Restart the workspace for the changes to take effect. |
Oops, something went wrong.