Skip to content

Commit d737726

Browse files
jc-bergerRobert Krátký
and
Robert Krátký
authored
Modified docs to adhere to schema_4th PR (#46)
* 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 * fixec capitalization * Update docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc Co-authored-by: Robert Krátký <[email protected]> * Update docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc Co-authored-by: Robert Krátký <[email protected]> * Update docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc Co-authored-by: Robert Krátký <[email protected]> * Update docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc Co-authored-by: Robert Krátký <[email protected]> * Update docs/modules/user-guide/partials/proc_migrating-commands.adoc Co-authored-by: Robert Krátký <[email protected]> Co-authored-by: jc-berger <> Co-authored-by: Robert Krátký <[email protected]>
1 parent f72a9ee commit d737726

File tree

2 files changed

+24
-83
lines changed

2 files changed

+24
-83
lines changed

Diff for: docs/modules/user-guide/partials/proc_migrating-commands.adoc

+13-13
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,33 @@
22
= Migrating commands
33

44
[role="_abstract"]
5-
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.
5+
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.
66

77
.Procedure
88

9-
. Command Groups: build,run,test,debug.
10-
. Apply Command.
11-
. Environment Varibables for a Specific Command.
12-
. Renaming workdir into workingDir.
13-
. Id and label for Composite Commands.
14-
. Run exec Commands as Specific User.
9+
. Command groups: build, run, test, debug.
10+
. Apply command.
11+
. Environment variables for a specific command.
12+
. Renaming workdir into workingDir.
13+
. Id and label for composite commands.
14+
. Run exec commands as specific user.
1515
. Devfile metadata: add a link to an external website.
16-
. Stack/Devfile Matching Rules.
16+
. Stack and devfile matching rules.
1717

1818
[role="_additional-resources"]
1919
.Additional resources
2020

21-
* Command Groups: build,run,test,debug. See https://github.com/che-incubator/devworkspace-api/issues/27[corresponding issue].
21+
* Command groups: build, run, test, debug. See https://github.com/che-incubator/devworkspace-api/issues/27[corresponding issue].
2222
* Apply Command. See https://github.com/devfile/api/issues/56[corresponding issue].
2323

24-
* Environment Varibables for a Specific Command. See https://github.com/che-incubator/devworkspace-api/issues/21[corresponding issue].
24+
* Environment variables for a specific command. See https://github.com/che-incubator/devworkspace-api/issues/21[corresponding issue].
2525

2626
* Renaming workdir into workingDir. See https://github.com/che-incubator/devworkspace-api/issues/22[corresponding issue].
2727

28-
* Id and label for Composite Commands. See https://github.com/che-incubator/devworkspace-api/issues/18[corresponding issue].
28+
* Id and label for composite commands. See https://github.com/che-incubator/devworkspace-api/issues/18[corresponding issue].
2929

30-
* Run exec Commands as Specific User. See https://github.com/che-incubator/devworkspace-api/issues/34[corresponding issue].
30+
* Run exec commands as specific user. See https://github.com/che-incubator/devworkspace-api/issues/34[corresponding issue].
3131

3232
* Devfile metadata: add a link to an external website. See https://github.com/che-incubator/devworkspace-api/issues/38[corresponding issue].
3333

34-
* Stack/Devfile Matching Rules. See https://github.com/che-incubator/devworkspace-api/issues/40[corresponding issue].
34+
* Stack and devfile matching rules. See https://github.com/che-incubator/devworkspace-api/issues/40[corresponding issue].

Diff for: docs/modules/user-guide/partials/proc_migrating-plug-ins.adoc

+11-70
Original file line numberDiff line numberDiff line change
@@ -2,79 +2,20 @@
22
= Migrating plug-ins
33

44
[role="_abstract"]
5-
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.
5+
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.
66

7-
.Procedure
7+
Additionally, v2.x devfiles include the following new features:
88

9-
. 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.
10-
11-
[source,yaml]
12-
----
13-
v2.0
14-
---
15-
java8.yaml
16-
---
17-
schemaVersion: 2.0.0
18-
metadata:
19-
publisher: redhat
20-
name: java8
21-
version: 0.57.0
22-
displayName: Language Support for Java 8
23-
title: Language Support for Java(TM) by ...
24-
description: Java Linting, Intellisense ...
25-
icon: https://.../logo-eclipseche.svg
26-
repository: https://github.../vscode-java
27-
category: Language
28-
firstPublicationDate: "2020-02-20"
29-
pluginType: che-theia-vsx # <== mandatory
30-
# for plugins
31-
# Valid types:
32-
# che-theia-vsx
33-
# che-editor,
34-
# che-theia-plugin,
35-
# che-theia-ext,
36-
# generic-service,
37-
# generic-ui
38-
parent:
39-
id: redhat/theia-vsx-template/latest
40-
components:
41-
- container:
42-
name: vsx-installer
43-
env:
44-
- name: VSX_LIST
45-
value: java-dbg.vsix,java.vsix
46-
components:
47-
- kubernetes:
48-
name: ...
49-
reference: ...
50-
- container:
51-
image: ...che-sidecar-java
52-
name: vscode-java
53-
memoryLimit: "1500Mi"
54-
volumeMounts:
55-
- path: "/home/theia/.m2"
56-
name: m2
57-
- volume:
58-
name: m2
59-
----
60-
61-
. And then can be referenced from a distinct devfile:
62-
63-
[source,yaml]
64-
----
65-
v2.0
66-
---
67-
devfile.yaml
68-
---
69-
components:
70-
- plugin:
71-
name: java language server
72-
id: redhat/java11/0.57.0 # other then by `id`, a plugin
73-
# can be referenced by `uri` and
74-
# `kubernetes`
75-
----
9+
* Parents allow users to reuse an existing devfile and partially replace plug-in functionality.
10+
* 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`.
7611

7712

7813
[role="_additional-resources"]
7914
.Additional resources
80-
* See https://github.com/che-incubator/devworkspace-api/issues/31[corresponding issue].
15+
16+
To learn more about plug-ins in v2.x devfiles, go to the GitHub issues on the following topics:
17+
18+
* link:https://github.com/eclipse/che/issues/18669[Devfile plugins not suited to specify Che-Theia plugins].
19+
* link:https://github.com/eclipse/che/issues/18668[Che editors and Che-Theia plugins support in devfile v2.x].
20+
* link:https://github.com/devfile/api/issues/364[Plugins' replacement].
21+
* link:https://github.com/devfile/api/issues/31[Better plugin mechanism].

0 commit comments

Comments
 (0)