Skip to content

Commit 7b1fee9

Browse files
olexii4olexii4
authored
feat: add info about hiding editor definitions (#2908)
* feat: hiding editors definitions Signed-off-by: Oleksii Orel <oorel@redhat.com> * fixup! feat: hiding editors definitions Signed-off-by: Oleksii Orel <oorel@redhat.com> * fixup! fixup! feat: hiding editors definitions Signed-off-by: Oleksii Orel <oorel@redhat.com> * fixup! fixup! fixup! feat: hiding editors definitions Signed-off-by: Oleksii Orel <oorel@redhat.com> * fixup! fixup! fixup! fixup! feat: hiding editors definitions Signed-off-by: Oleksii Orel <oorel@redhat.com> * fixup! fixup! fixup! fixup! fixup! feat: hiding editors definitions Signed-off-by: Oleksii Orel <oorel@redhat.com> --------- Signed-off-by: Oleksii Orel <oorel@redhat.com>
1 parent 01ca8f1 commit 7b1fee9

File tree

7 files changed

+111
-189
lines changed

7 files changed

+111
-189
lines changed

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
:_content-type: SNIPPET
2+
3+
. An editor ID has the following format: `publisher/name/version`. Find out the IDs of the available editors:
4+
+
5+
[source,subs="+quotes,+attributes"]
6+
----
7+
{orch-cli} exec deploy/{prod-id-short}-dashboard -n {prod-namespace} \
8+
-- curl -s http://localhost:8080/dashboard/api/editors | jq -r '[.[] | "\(.metadata.attributes.publisher)/\(.metadata.name)/\(.metadata.attributes.version)"]'
9+
----

‎modules/administration-guide/nav.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,9 @@
8686
** xref:configuring-dashboard.adoc[]
8787
*** xref:configuring-getting-started-samples.adoc[]
8888
*** xref:configuring-editors-definitions.adoc[]
89-
*** xref:configuring-default-editor-definition.adoc[]
90-
*** xref:concealing-editors-definitions.adoc[]
89+
*** xref:show-deprecated-editors.adoc[]
90+
*** xref:configuring-default-editor.adoc[]
91+
*** xref:concealing-editors.adoc[]
9192
*** xref:customizing-openshift-che-consolelink-icon.adoc[]
9293
** xref:managing-identities-and-authorizations.adoc[]
9394
*** xref:configuring-oauth-for-git-providers.adoc[]

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

Lines changed: 0 additions & 173 deletions
This file was deleted.

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

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
:_content-type: PROCEDURE
2+
:description: Concealing editors in the Dashboard UI
3+
:keywords: administration guide, concealing, dashboard, editors
4+
:navtitle: Concealing editors
5+
6+
[id="concealing-editors"]
7+
= Concealing editors
8+
9+
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.
10+
11+
.Prerequisites
12+
13+
* An active `{orch-cli}` session with administrative permissions to the {orch-name} cluster. See {orch-cli-link}.
14+
15+
* `jq`. See link:https://stedolan.github.io/jq/download/[Downloading `jq`].
16+
17+
.Procedure
18+
19+
include::example$snip_che-editor-id-list.adoc[]
20+
21+
. Configure the `CheCluster` Custom Resource. See xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
22+
+
23+
[source,yaml]
24+
----
25+
spec:
26+
components:
27+
dashboard:
28+
deployment:
29+
containers:
30+
- env:
31+
- name: CHE_HIDE_EDITORS_BY_ID
32+
value: 'che-incubator/che-webstorm-server/latest, che-incubator/che-webstorm-server/next' <1>
33+
----
34+
<1> A string containing comma-separated IDs of editors to hide.
35+
36+
.Additional resources
37+
38+
* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
39+
40+
* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
41+
42+
* {editor-definition-samples-link}
43+

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,11 @@
1111

1212
* xref:configuring-editors-definitions.adoc[]
1313

14-
* xref:configuring-default-editor-definition.adoc[]
14+
* xref:show-deprecated-editors.adoc[]
1515

16-
* xref:concealing-editors-definitions.adoc[]
16+
* xref:configuring-default-editor.adoc[]
17+
18+
* xref:concealing-editors.adoc[]
1719

1820
* xref:customizing-openshift-che-consolelink-icon.adoc[]
1921

‎modules/administration-guide/pages/configuring-default-editor-definition.adoc renamed to ‎modules/administration-guide/pages/configuring-default-editor.adoc

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
:_content-type: PROCEDURE
22
:description: Configuring default editor
33
:keywords: administration guide, dashboard, editors
4-
:navtitle: Configuring default editor definition
4+
:navtitle: Configuring default editor
55

6-
[id="configuring-default-editor-definition"]
7-
= Configuring default editor definition
6+
[id="configuring-default-editor"]
7+
= Configuring default editor
88

9-
Learn how to configure {prod-short} default editor definition.
9+
Learn how to configure {prod-short} default editor.
1010

1111
.Prerequisites
1212

@@ -16,13 +16,7 @@ Learn how to configure {prod-short} default editor definition.
1616

1717
.Procedure
1818

19-
. Find out the IDs of the available editors:
20-
+
21-
[source,subs="+quotes,+attributes"]
22-
----
23-
{orch-cli} exec deploy/{prod-id-short}-dashboard -n {prod-namespace} \
24-
-- curl -s http://localhost:8080/dashboard/api/editors | jq -r '.[] | "\(.metadata.attributes.publisher)/\(.metadata.name)/\(.metadata.attributes.version)"'
25-
----
19+
include::example$snip_che-editor-id-list.adoc[]
2620

2721
. Configure the `defaultEditor`:
2822
+
@@ -39,7 +33,7 @@ Learn how to configure {prod-short} default editor definition.
3933

4034
* xref:configuring-editors-definitions.adoc[]
4135

42-
* xref:concealing-editors-definitions.adoc[]
36+
* xref:concealing-editors.adoc[]
4337

4438
* {editor-definition-samples-link}
4539

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

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
:_content-type: PROCEDURE
2+
:description: Show deprecated editors
3+
:keywords: administration guide, show deprecated, dashboard, editors
4+
:navtitle: Show deprecated editors
5+
:page-aliases: installation-guide:show-deprecated-editors.adoc
6+
7+
[id="show-deprecated-editors"]
8+
= Show deprecated editors
9+
10+
Learn how to show deprecated {prod-short} editors on the Dashboard. By default, the Dashboard UI hides them.
11+
12+
.Prerequisites
13+
14+
* An active `{orch-cli}` session with administrative permissions to the {orch-name} cluster. See {orch-cli-link}.
15+
16+
* `jq`. See link:https://stedolan.github.io/jq/download/[Downloading `jq`].
17+
18+
.Procedure
19+
20+
. An editor ID has the following format: `publisher/name/version`. Find out the IDs of the deprecated editors:
21+
+
22+
[source,subs="+quotes,+attributes"]
23+
----
24+
{orch-cli} exec deploy/{prod-id-short}-dashboard -n {prod-namespace} \
25+
-- 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)"]'
26+
----
27+
28+
. Configure the `CheCluster` Custom Resource. See xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
29+
+
30+
[source,yaml]
31+
----
32+
spec:
33+
components:
34+
dashboard:
35+
deployment:
36+
containers:
37+
- env:
38+
- name: CHE_SHOW_DEPRECATED_EDITORS
39+
value: 'true'
40+
----
41+
42+
.Additional resources
43+
44+
* xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
45+
46+
* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]

0 commit comments

Comments
 (0)