feat: add info about hiding editor definitions

modules/administration-guide/examples/snip_che-editor-id-list.adoc

@@ -0,0 +1,9 @@
+:_content-type: SNIPPET
+
+. An editor ID has the following format: `publisher/name/version`. Find out the IDs of the available editors:
++
+[source,subs="+quotes,+attributes"]
+----
+{orch-cli} exec deploy/{prod-id-short}-dashboard -n {prod-namespace}  \
+    -- curl -s http://localhost:8080/dashboard/api/editors | jq -r '[.[] | "\(.metadata.attributes.publisher)/\(.metadata.name)/\(.metadata.attributes.version)"]'
+----

modules/administration-guide/nav.adoc

@@ -86,8 +86,9 @@
 ** xref:configuring-dashboard.adoc[]
 *** xref:configuring-getting-started-samples.adoc[]
 *** xref:configuring-editors-definitions.adoc[]
-*** xref:configuring-default-editor-definition.adoc[]
-*** xref:concealing-editors-definitions.adoc[]
+*** xref:show-deprecated-editors.adoc[]
+*** xref:configuring-default-editor.adoc[]
+*** xref:concealing-editors.adoc[]
 *** xref:customizing-openshift-che-consolelink-icon.adoc[]
 ** xref:managing-identities-and-authorizations.adoc[]
 *** xref:configuring-oauth-for-git-providers.adoc[]

modules/administration-guide/pages/concealing-editors.adoc

@@ -0,0 +1,43 @@
+:_content-type: PROCEDURE
+:description: Concealing editors in the Dashboard UI
+:keywords: administration guide, concealing, dashboard, editors
+:navtitle: Concealing editors
+
+[id="concealing-editors"]
+= Concealing editors
+
+Learn how to conceal {prod-short} editor. This is useful when you want to hide selected editors from the Dashboard UI, e.g. hide the IntelliJ IDEA Ultimate and have only Visual Studio Code - Open Source visible.
+
+.Prerequisites
+
+* An active `{orch-cli}` session with administrative permissions to the {orch-name} cluster. See {orch-cli-link}.
+
+* `jq`. See link:https://stedolan.github.io/jq/download/[Downloading `jq`].
+
+.Procedure
+
+include::example$snip_che-editor-id-list.adoc[]
+
+. Configure the `CheCluster` Custom Resource. See xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
++
+[source,yaml]
+----
+spec:
+  components:
+    dashboard:
+      deployment:
+        containers:
+        - env:
+          - name: CHE_HIDE_EDITORS_BY_ID
+            value: 'che-incubator/che-webstorm-server/latest, che-incubator/che-webstorm-server/next' <1>
+----
+<1> A string containing comma-separated IDs of editors to hide.
+
+.Additional resources
+
+* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
+
+* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
+
+* {editor-definition-samples-link}
+

modules/administration-guide/pages/configuring-dashboard.adoc

@@ -11,9 +11,11 @@
 
 * xref:configuring-editors-definitions.adoc[]
 
-* xref:configuring-default-editor-definition.adoc[]
+* xref:show-deprecated-editors.adoc[]
 
-* xref:concealing-editors-definitions.adoc[]
+* xref:configuring-default-editor.adoc[]
+
+* xref:concealing-editors.adoc[]
 
 * xref:customizing-openshift-che-consolelink-icon.adoc[]
 

modules/administration-guide/pages/configuring-default-editor-definition.adoc → modules/administration-guide/pages/configuring-default-editor.adoc

@@ -1,12 +1,12 @@
 :_content-type: PROCEDURE
 :description: Configuring default editor
 :keywords: administration guide, dashboard, editors
-:navtitle: Configuring default editor definition
+:navtitle: Configuring default editor
 
-[id="configuring-default-editor-definition"]
-= Configuring default editor definition
+[id="configuring-default-editor"]
+= Configuring default editor
 
-Learn how to configure {prod-short} default editor definition.
+Learn how to configure {prod-short} default editor.
 
 .Prerequisites
 
@@ -16,13 +16,7 @@ Learn how to configure {prod-short} default editor definition.
 
 .Procedure
 
-. Find out the IDs of the available editors:
-+
-[source,subs="+quotes,+attributes"]
-----
-{orch-cli} exec deploy/{prod-id-short}-dashboard -n {prod-namespace}  \
-    -- curl -s http://localhost:8080/dashboard/api/editors | jq -r '.[] | "\(.metadata.attributes.publisher)/\(.metadata.name)/\(.metadata.attributes.version)"'
-----
+include::example$snip_che-editor-id-list.adoc[]
 
 . Configure the `defaultEditor`:
 +
@@ -39,7 +33,7 @@ Learn how to configure {prod-short} default editor definition.
 
 * xref:configuring-editors-definitions.adoc[]
 
-* xref:concealing-editors-definitions.adoc[]
+* xref:concealing-editors.adoc[]
 
 * {editor-definition-samples-link}
 

modules/administration-guide/pages/managing-workloads-using-the-che-server-api.adoc

@@ -1,17 +1,19 @@
 :_content-type: PROCEDURE
-:description: Managing {prod-short} server workloads using the {prod-short} server API
+:description: Managing {prod-short} server and {prod-short} dashboard workloads using the API
 :keywords: administration-guide, api
 :navtitle: Using the {prod-short} server API
 :page-aliases:
 
 [id="managing-workloads-using-the-{prod-id-short}-server-api"]
-= Managing {prod-short} server workloads using the {prod-short} server API
+= Managing {prod-short} server and {prod-short} dashboard workloads using the API
 
-To manage {prod-short} server workloads, use the Swagger web user interface to navigate {prod-short} server API.
+To manage {prod-short} server and {prod-short} dashboard workloads, use the Swagger web user interface to navigate API.
 
 .Procedure
 
-* Navigate to the Swagger API web user interface: `pass:c,a,q[{prod-url}]/swagger`.
+* Navigate to the Swagger API web user interface:
+ - `pass:c,a,q[{prod-url}]/swagger`   ({prod-short} server)
+ - `pass:c,a,q[{prod-url}]/dashboard/api/swagger`   ({prod-short} dashboard)
 
 .Additional resources
 

modules/administration-guide/pages/show-deprecated-editors.adoc

@@ -0,0 +1,48 @@
+:_content-type: PROCEDURE
+:description: Show deprecated editors
+:keywords: administration guide, show deprecated, dashboard, editors
+:navtitle:  Show deprecated editors
+:page-aliases: installation-guide:show-deprecated-editors.adoc
+
+[id="show-deprecated-editors"]
+= Show deprecated editors
+
+Learn how to show deprecated {prod-short} editors.
+
+NOTE: By default, the deprecated editors are hidden in the Dashboard UI. To show them, you need to set the `CHE_SHOW_DEPRECATED_EDITORS` environment variable to `true`.
+
+.Prerequisites
+
+* An active `{orch-cli}` session with administrative permissions to the {orch-name} cluster. See {orch-cli-link}.
+
+* `jq`. See link:https://stedolan.github.io/jq/download/[Downloading `jq`].
+
+.Procedure
+
+. An editor ID has the following format: `publisher/name/version`. Find out the IDs of the deprecated editors:
++
+[source,subs="+quotes,+attributes"]
+----
+{orch-cli} exec deploy/{prod-id-short}-dashboard -n {prod-namespace}  \
+    -- curl -s http://localhost:8080/dashboard/api/editors | jq -r '[.[] | select(.metadata.tags != null) | select(.metadata.tags[] | contains("Deprecate")) | "\(.metadata.attributes.publisher)/\(.metadata.name)/\(.metadata.attributes.version)"]'
+----
+
+. Configure the `CheCluster` Custom Resource. See xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
++
+[source,yaml]
+----
+spec:
+  components:
+    dashboard:
+      deployment:
+        containers:
+        - env:
+          - name: CHE_SHOW_DEPRECATED_EDITORS
+            value: 'true'
+----
+
+.Additional resources
+
+* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
+
+* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]