Skip to content

Commit 5232616

Browse files
authored
feat: Explain how users can override the editor's container image (#2687)
* feat: Explain how users can override the editor's container image Signed-off-by: Oleksii Orel <oorel@redhat.com>
1 parent 2d9422d commit 5232616

File tree

3 files changed

+37
-0
lines changed

3 files changed

+37
-0
lines changed

modules/end-user-guide/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
*** xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[]
66
**** xref:url-parameter-concatenation.adoc[]
77
**** xref:url-parameter-for-the-ide.adoc[]
8+
**** xref:url-parameter-for-the-ide-image.adoc[]
89
**** xref:url-parameter-for-starting-duplicate-workspaces.adoc[]
910
**** xref:url-parameter-for-the-devfile-file-name.adoc[]
1011
**** xref:url-parameter-for-the-devfile-file-path.adoc[]

modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ When you start a new workspace, {prod-short} configures the workspace according
1111

1212
* xref:url-parameter-concatenation.adoc[]
1313
* xref:url-parameter-for-the-ide.adoc[]
14+
* xref:url-parameter-for-the-ide-image.adoc[]
1415
* xref:url-parameter-for-starting-duplicate-workspaces.adoc[]
1516
* xref:url-parameter-for-the-devfile-file-name.adoc[]
1617
* xref:url-parameter-for-the-devfile-file-path.adoc[]
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
:_content-type: CONCEPT
2+
:description: URL parameter for the IDE image
3+
:keywords: parameter, URL, IDE, image
4+
:navtitle: URL parameter for the IDE image
5+
//:page-aliases:
6+
7+
[id="url-parameter-for-the-ide-image"]
8+
= URL parameter for the IDE image
9+
10+
You can use the `editor-image` parameter to set the custom IDE image for the workspace.
11+
12+
[IMPORTANT]
13+
====
14+
15+
* If the Git repository contains xref:defining-a-common-ide.adoc[`/.che/che-editor.yaml`] file, the custom editor will be overridden with the new IDE image.
16+
17+
* If there is no xref:defining-a-common-ide.adoc[`/.che/che-editor.yaml`] file in the Git repository, the default editor will be overridden with the new IDE image.
18+
19+
* If you want to override the supported IDE and change the target editor image, you can use both parameters together: `che-editor` and `editor-image` URL parameters.
20+
21+
====
22+
23+
The URL parameter to override the IDE image is `editor-image=`:
24+
25+
[source,subs="+quotes,+attributes,+macros"]
26+
----
27+
pass:c,a,q[{prod-url}]#__<git_repository_url>__?editor-image=__<container_registry/image_name:image_tag>__
28+
----
29+
30+
.Example:
31+
`pass:c,a,q[{prod-url}]#https://github.com/eclipse-che/che-docs?editor-image=quay.io/che-incubator/che-code:next`
32+
33+
or
34+
35+
`pass:c,a,q[{prod-url}]#https://github.com/eclipse-che/che-docs?che-editor=che-incubator/che-code/latest&editor-image=quay.io/che-incubator/che-code:next`

0 commit comments

Comments
 (0)