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 <[email protected]>

modules/end-user-guide/nav.adoc

@@ -5,6 +5,7 @@
 *** xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[]
 **** xref:url-parameter-concatenation.adoc[]
 **** xref:url-parameter-for-the-ide.adoc[]
+**** xref:url-parameter-for-the-ide-image.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[]

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

@@ -11,6 +11,7 @@ When you start a new workspace, {prod-short} configures the workspace according
 
 * xref:url-parameter-concatenation.adoc[]
 * xref:url-parameter-for-the-ide.adoc[]
+* xref:url-parameter-for-the-ide-image.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[]

modules/end-user-guide/pages/url-parameter-for-the-ide-image.adoc

@@ -0,0 +1,35 @@
+:_content-type: CONCEPT
+:description: URL parameter for the IDE image
+:keywords: parameter, URL, IDE, image
+:navtitle: URL parameter for the IDE image
+//:page-aliases:
+
+[id="url-parameter-for-the-ide-image"]
+= URL parameter for the IDE image
+
+You can use the `editor-image` parameter to set the custom IDE image for the workspace.
+
+[IMPORTANT]
+====
+
+* 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.
+
+* 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.
+
+* 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.
+
+====
+
+The URL parameter to override the IDE image is `editor-image=`:
+
+[source,subs="+quotes,+attributes,+macros"]
+----
+pass:c,a,q[{prod-url}]#__<git_repository_url>__?editor-image=__<container_registry/image_name:image_tag>__
+----
+
+.Example:
+`pass:c,a,q[{prod-url}]#https://github.com/eclipse-che/che-docs?editor-image=quay.io/che-incubator/che-code:next`
+
+or
+
+`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`