From 27a36df1a8dfb802a3e3a9728a0c29cdadb37d38 Mon Sep 17 00:00:00 2001 From: jc-berger Date: Thu, 4 Mar 2021 09:50:45 -0500 Subject: [PATCH 1/7] modified docs to adhere to schema_4th PR minor tweaks to yaml minor change to migrating commands doc added infor on more devfile v2 features removed procedure from plugin doc and other minor changes fixed devfile v2.x minor language change to bullet point --- .../partials/proc_migrating-commands.adoc | 20 ++--- .../partials/proc_migrating-plug-ins.adoc | 81 +++---------------- 2 files changed, 21 insertions(+), 80 deletions(-) diff --git a/docs/modules/user-guide/partials/proc_migrating-commands.adoc b/docs/modules/user-guide/partials/proc_migrating-commands.adoc index 6339fc16..aa1cb878 100644 --- a/docs/modules/user-guide/partials/proc_migrating-commands.adoc +++ b/docs/modules/user-guide/partials/proc_migrating-commands.adoc @@ -2,18 +2,18 @@ = Migrating commands [role="_abstract"] -This section describes how to migrate plug-ins to devfile v2. There ARE major changes in the `commands` section of the devfile. A command specified in a v1.0 devfile will NOT work as it is in a devfile v2.0. +This section describes how to migrate commands to devfile v2.x. There ARE major changes in the `commands` section of the devfile. A command specified in a v1.0 devfile will NOT work as it is in a devfile v2.x. .Procedure -. Command Groups: build,run,test,debug. -. Apply Command. -. Environment Varibables for a Specific Command. -. Renaming workdir into workingDir. -. Id and label for Composite Commands. -. Run exec Commands as Specific User. +. Command Groups: build, run, test, debug. +. Apply Command. +. Environment Variables for a Specific Command. +. Renaming workdir into workingDir. +. Id and label for Composite Commands. +. Run exec Commands as Specific User. . Devfile metadata: add a link to an external website. -. Stack/Devfile Matching Rules. +. Stack and Devfile Matching Rules. [role="_additional-resources"] .Additional resources @@ -21,7 +21,7 @@ This section describes how to migrate plug-ins to devfile v2. There ARE major ch * Command Groups: build,run,test,debug. See https://github.com/che-incubator/devworkspace-api/issues/27[corresponding issue]. * Apply Command. See https://github.com/devfile/api/issues/56[corresponding issue]. -* Environment Varibables for a Specific Command. See https://github.com/che-incubator/devworkspace-api/issues/21[corresponding issue]. +* Environment Variables for a Specific Command. See https://github.com/che-incubator/devworkspace-api/issues/21[corresponding issue]. * Renaming workdir into workingDir. See https://github.com/che-incubator/devworkspace-api/issues/22[corresponding issue]. @@ -31,4 +31,4 @@ This section describes how to migrate plug-ins to devfile v2. There ARE major ch * Devfile metadata: add a link to an external website. See https://github.com/che-incubator/devworkspace-api/issues/38[corresponding issue]. -* Stack/Devfile Matching Rules. See https://github.com/che-incubator/devworkspace-api/issues/40[corresponding issue]. \ No newline at end of file +* Stack and Devfile Matching Rules. See https://github.com/che-incubator/devworkspace-api/issues/40[corresponding issue]. diff --git a/docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc b/docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc index 97e170a4..3c5aa279 100644 --- a/docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc +++ b/docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc @@ -2,79 +2,20 @@ = Migrating plug-ins [role="_abstract"] -This section describes how to migrate plug-ins to devfile v2. There ARE major changes about the definition of plugins in a devfile. Plugins are now specified using a devfile. A plugin specified in a v1.0 meta.yaml will NOT work as it is in a devfile v2.0. +This section describes how to migrate plug-ins to devfile v2.x. There ARE major changes about the definition of plugins in a devfile. Plugins are now specified using a devfile. A plugin specified in a v1.0 meta.yaml will NOT work as it is in a devfile v2.x. -.Procedure +Additionally, v2.x devfiles include the following new features: -. Plugins are now specified using a devfile. A plugin specified in a v1.0 meta.yaml will NOT work as it is in a devfile v2.0. - -[source,yaml] ----- -v2.0 ---- -java8.yaml ---- -schemaVersion: 2.0.0 -metadata: - publisher: redhat - name: java8 - version: 0.57.0 - displayName: Language Support for Java 8 - title: Language Support for Java(TM) by ... - description: Java Linting, Intellisense ... - icon: https://.../logo-eclipseche.svg - repository: https://github.../vscode-java - category: Language - firstPublicationDate: "2020-02-20" - pluginType: che-theia-vsx # <== mandatory - # for plugins - # Valid types: - # che-theia-vsx - # che-editor, - # che-theia-plugin, - # che-theia-ext, - # generic-service, - # generic-ui -parent: - id: redhat/theia-vsx-template/latest - components: - - container: - name: vsx-installer - env: - - name: VSX_LIST - value: java-dbg.vsix,java.vsix -components: - - kubernetes: - name: ... - reference: ... - - container: - image: ...che-sidecar-java - name: vscode-java - memoryLimit: "1500Mi" - volumeMounts: - - path: "/home/theia/.m2" - name: m2 - - volume: - name: m2 ----- - -. And then can be referenced from a distinct devfile: - -[source,yaml] ----- -v2.0 ---- -devfile.yaml ---- -components: -- plugin: - name: java language server - id: redhat/java11/0.57.0 # other then by `id`, a plugin - # can be referenced by `uri` and - # `kubernetes` ----- +* Parents allow users to reuse an existing devfile and partially replace a plugin's functionality. +* Che IDEs and their tooling can be specified as attributes in a v2.x devfile or in a distinct yaml file, for example: `.che/che-editor.yaml` or `.che/che-theia-plugin.yaml`. [role="_additional-resources"] .Additional resources -* See https://github.com/che-incubator/devworkspace-api/issues/31[corresponding issue]. + +To learn more about plugins in v2.x devfiles, go to the GitHub issues on the following topics: + +* link:https://github.com/eclipse/che/issues/18669[Devfile plugins not suited to specify Che-Theia plugins]. +* link:https://github.com/eclipse/che/issues/18668[Che editors and Che-Theia plugins support in devfile v2.x]. +* link:https://github.com/devfile/api/issues/364[Plugins' replacement]. +* link:https://github.com/devfile/api/issues/31[Better plugin mechanism]. From 7136ee1a592ca93942c017da648b42b94733ccad Mon Sep 17 00:00:00 2001 From: jc-berger <> Date: Wed, 31 Mar 2021 13:34:24 -0400 Subject: [PATCH 2/7] fixec capitalization --- .../partials/proc_migrating-commands.adoc | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/modules/user-guide/partials/proc_migrating-commands.adoc b/docs/modules/user-guide/partials/proc_migrating-commands.adoc index aa1cb878..7203c5bb 100644 --- a/docs/modules/user-guide/partials/proc_migrating-commands.adoc +++ b/docs/modules/user-guide/partials/proc_migrating-commands.adoc @@ -6,29 +6,29 @@ This section describes how to migrate commands to devfile v2.x. There ARE major .Procedure -. Command Groups: build, run, test, debug. -. Apply Command. -. Environment Variables for a Specific Command. +. Command groups: build, run, test, debug. +. Apply command. +. Environment variables for a specific command. . Renaming workdir into workingDir. -. Id and label for Composite Commands. -. Run exec Commands as Specific User. +. Id and label for composite commands. +. Run exec commands as specific user. . Devfile metadata: add a link to an external website. -. Stack and Devfile Matching Rules. +. Stack and devfile matching rules. [role="_additional-resources"] .Additional resources -* Command Groups: build,run,test,debug. See https://github.com/che-incubator/devworkspace-api/issues/27[corresponding issue]. +* Command groups: build, run, test, debug. See https://github.com/che-incubator/devworkspace-api/issues/27[corresponding issue]. * Apply Command. See https://github.com/devfile/api/issues/56[corresponding issue]. -* Environment Variables for a Specific Command. See https://github.com/che-incubator/devworkspace-api/issues/21[corresponding issue]. +* Environment variables for a specific command. See https://github.com/che-incubator/devworkspace-api/issues/21[corresponding issue]. * Renaming workdir into workingDir. See https://github.com/che-incubator/devworkspace-api/issues/22[corresponding issue]. -* Id and label for Composite Commands. See https://github.com/che-incubator/devworkspace-api/issues/18[corresponding issue]. +* Id and label for composite commands. See https://github.com/che-incubator/devworkspace-api/issues/18[corresponding issue]. -* Run exec Commands as Specific User. See https://github.com/che-incubator/devworkspace-api/issues/34[corresponding issue]. +* Run exec commands as specific user. See https://github.com/che-incubator/devworkspace-api/issues/34[corresponding issue]. * Devfile metadata: add a link to an external website. See https://github.com/che-incubator/devworkspace-api/issues/38[corresponding issue]. -* Stack and Devfile Matching Rules. See https://github.com/che-incubator/devworkspace-api/issues/40[corresponding issue]. +* Stack and devfile matching rules. See https://github.com/che-incubator/devworkspace-api/issues/40[corresponding issue]. From 20a695b1b1a4caf5e71a51566f60919d44ecece6 Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Thu, 1 Apr 2021 11:26:09 -0400 Subject: [PATCH 3/7] Update docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc b/docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc index 3c5aa279..845d8104 100644 --- a/docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc +++ b/docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc @@ -13,7 +13,7 @@ Additionally, v2.x devfiles include the following new features: [role="_additional-resources"] .Additional resources -To learn more about plugins in v2.x devfiles, go to the GitHub issues on the following topics: +To learn more about plug-ins in v2.x devfiles, go to the GitHub issues on the following topics: * link:https://github.com/eclipse/che/issues/18669[Devfile plugins not suited to specify Che-Theia plugins]. * link:https://github.com/eclipse/che/issues/18668[Che editors and Che-Theia plugins support in devfile v2.x]. From d2e60ec0442e07f2aa2c4e5e4432702171959661 Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Thu, 1 Apr 2021 11:26:23 -0400 Subject: [PATCH 4/7] Update docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc b/docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc index 845d8104..2526e756 100644 --- a/docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc +++ b/docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc @@ -7,7 +7,7 @@ This section describes how to migrate plug-ins to devfile v2.x. There ARE major Additionally, v2.x devfiles include the following new features: * Parents allow users to reuse an existing devfile and partially replace a plugin's functionality. -* Che IDEs and their tooling can be specified as attributes in a v2.x devfile or in a distinct yaml file, for example: `.che/che-editor.yaml` or `.che/che-theia-plugin.yaml`. +* Eclipse Che IDEs and their tooling can be specified as attributes in a v2.x devfile or in a distinct YAML file, for example: `.che/che-editor.yaml` or `.che/che-theia-plugin.yaml`. [role="_additional-resources"] From 0f13f52f7619634f519b506d156a1061b404b58a Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Thu, 1 Apr 2021 11:26:42 -0400 Subject: [PATCH 5/7] Update docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc b/docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc index 2526e756..d4110d12 100644 --- a/docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc +++ b/docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc @@ -6,7 +6,7 @@ This section describes how to migrate plug-ins to devfile v2.x. There ARE major Additionally, v2.x devfiles include the following new features: -* Parents allow users to reuse an existing devfile and partially replace a plugin's functionality. +* Parents allow users to reuse an existing devfile and partially replace plug-in functionality. * Eclipse Che IDEs and their tooling can be specified as attributes in a v2.x devfile or in a distinct YAML file, for example: `.che/che-editor.yaml` or `.che/che-theia-plugin.yaml`. From 11d28d5e9f6306dea3c8108be57d47542fe6a64f Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Thu, 1 Apr 2021 11:26:58 -0400 Subject: [PATCH 6/7] Update docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc b/docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc index d4110d12..53bdc0f3 100644 --- a/docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc +++ b/docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc @@ -2,7 +2,7 @@ = Migrating plug-ins [role="_abstract"] -This section describes how to migrate plug-ins to devfile v2.x. There ARE major changes about the definition of plugins in a devfile. Plugins are now specified using a devfile. A plugin specified in a v1.0 meta.yaml will NOT work as it is in a devfile v2.x. +This section describes how to migrate plug-ins to devfile v2.x. Plug-ins are now specified using a devfile. A plug-in specified in a v1.0 `meta.yaml` does not work as it is in a devfile v2.x. Additionally, v2.x devfiles include the following new features: From d43c84aacb91902bcf656be5537d59e2e9b0b3ce Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Thu, 1 Apr 2021 11:27:22 -0400 Subject: [PATCH 7/7] Update docs/modules/user-guide/partials/proc_migrating-commands.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- docs/modules/user-guide/partials/proc_migrating-commands.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_migrating-commands.adoc b/docs/modules/user-guide/partials/proc_migrating-commands.adoc index 7203c5bb..6485d215 100644 --- a/docs/modules/user-guide/partials/proc_migrating-commands.adoc +++ b/docs/modules/user-guide/partials/proc_migrating-commands.adoc @@ -2,7 +2,7 @@ = Migrating commands [role="_abstract"] -This section describes how to migrate commands to devfile v2.x. There ARE major changes in the `commands` section of the devfile. A command specified in a v1.0 devfile will NOT work as it is in a devfile v2.x. +This section describes how to migrate the `commands` section to devfile v2.x. A command specified in a v1.0 devfile does not work as it is in a devfile v2.x. .Procedure