Skip to content

Commit

Permalink
remove 'cloud' from IDE
Browse files Browse the repository at this point in the history
  • Loading branch information
max-cx committed Mar 1, 2023
1 parent d0c5266 commit c873b62
Show file tree
Hide file tree
Showing 9 changed files with 29 additions and 29 deletions.
4 changes: 2 additions & 2 deletions modules/end-user-guide/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
** xref:starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc[]
** xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[]
*** xref:url-parameter-concatenation.adoc[]
*** xref:url-parameter-for-the-cloud-ide.adoc[]
*** xref:url-parameter-for-the-ide.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[]
Expand All @@ -19,7 +19,7 @@
** xref:authenticating-to-a-git-server-from-a-workspace.adoc[]
* xref:customizing-workspace-components.adoc[]
* xref:devfile-introduction.adoc[]
* xref:cloud-ides-in-workspaces.adoc[]
* xref:ides-in-workspaces.adoc[]
** xref:defining-a-common-ide.adoc[]
** xref:microsoft-visual-studio-code-open-source-ide.adoc[]
* xref:using-credentials-and-configurations-in-workspaces.adoc[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ To customize workspace components:

* xref:devfile-introduction.adoc[Use a devfile].

* xref:cloud-ides-in-workspaces.adoc[Configure a cloud IDE].
* xref:ides-in-workspaces.adoc[Configure an IDE].

* Add {prod-short} specific attributes in addition to the generic devfile specification.
2 changes: 1 addition & 1 deletion modules/end-user-guide/pages/defining-a-common-ide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[id="defining-a-common-ide"]
= Defining a common IDE

While the xref:url-parameter-for-the-cloud-ide.adoc[URL parameter for the cloud IDE] enables you to start a workspace with your personal choice of the supported IDE, you might find it more convenient to define the same cloud IDE, even with a more detailed IDE configuration, for all workspaces that will clone the same remote Git repository with your project source code. To do so, use the `che-editor.yaml` file.
While the xref:url-parameter-for-the-ide.adoc[URL parameter for the IDE] enables you to start a workspace with your personal choice of the supported IDE, you might find it more convenient to define the same IDE, even with a more detailed IDE configuration, for all workspaces that will clone the same remote Git repository with your project source code. To do so, use the `che-editor.yaml` file.

include::partial$proc_setting-up-che-editor-yaml.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
:_content-type: PROCEDURE
:description: Cloud IDEs in workspaces
:description: IDEs in workspaces
:keywords: configuring, workspace, editor, ide, cloud ide
:navtitle: Cloud IDEs in workspaces
:navtitle: IDEs in workspaces
:page-aliases:

[id="cloud-ides-in-workspaces"]
= Cloud IDEs in workspaces
[id="ides-in-workspaces"]
= IDEs in workspaces

== Supported cloud IDEs
== Supported IDEs

The default cloud IDE in a new workspace is Microsoft Visual Studio Code - Open Source. Alternatively, you can choose another supported IDE:
The default IDE in a new workspace is Microsoft Visual Studio Code - Open Source. Alternatively, you can choose another supported IDE:

.Supported cloud IDEs
.Supported IDEs

[cols="1,1a,1a"]
|===
| Cloud IDE | `id` | Note
| IDE | `id` | Note

include::example$snip_{project-context}-table-of-supported-editors.adoc[]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[id="microsoft-visual-studio-code-open-source-ide"]
= Microsoft Visual Studio Code - Open Source IDE

The {prod-short} build of link:https://github.com/microsoft/vscode[Microsoft Visual Studio Code - Open Source] is the default cloud IDE of a new workspace.
The {prod-short} build of link:https://github.com/microsoft/vscode[Microsoft Visual Studio Code - Open Source] is the default IDE of a new workspace.

You can have extensions automatically installed in this IDE for workspaces, as explained in the next section, from the xref:administration-guide:extensions-for-microsoft-visual-studio-code-open-source.adoc[Open VSX registry].

Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
:_content-type: CONCEPT
:description: URL parameter for the cloud IDE
:description: URL parameter for the IDE
:keywords: ide, editor, workspace-ide, workspace-editor
:navtitle: URL parameter for the cloud IDE
:navtitle: URL parameter for the IDE
:page-aliases: url-parameter-for-the-in-browser-ide.adoc

[id="url-parameter-for-the-cloud-ide"]
= URL parameter for the cloud IDE
[id="url-parameter-for-the-ide"]
= URL parameter for the IDE

If the URL for starting a new workspace doesn't contain a parameter specifying the integrated development environment (IDE), the workspace loads with the default cloud IDE, which is Microsoft Visual Studio Code - Open Source.
If the URL for starting a new workspace doesn't contain a parameter specifying the integrated development environment (IDE), the workspace loads with the default IDE, which is Microsoft Visual Studio Code - Open Source.

The URL parameter for specifying a supported cloud IDE is `che-editor=`. You can use it to start a workspace with a clone of the same project repository and your choice of a supported cloud IDE.
The URL parameter for specifying a supported IDE is `che-editor=`. You can use it to start a workspace with a clone of the same project repository and your choice of a supported IDE.

TIP: You can use the `che-editor=` parameter when you cannot add or edit a xref:defining-a-common-ide.adoc[`/.che/che-editor.yaml`] file in the source-code Git repository to be cloned for workspaces.

Expand All @@ -25,10 +25,10 @@ pass:c,a,q[{prod-url}]#__<git_repository_url>__?che-editor=__<editor_key>__
----
+

.The URL parameter `__<editor_key>__` values for supported cloud IDEs
.The URL parameter `__<editor_key>__` values for supported IDEs
[cols="1,1a,1a"]
|===
| Cloud IDE | `__<editor_key>__` value | Note
| IDE | `__<editor_key>__` value | Note

include::example$snip_{project-context}-table-of-supported-editors.adoc[]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[id="adding-vs-code-extensions"]
= Adding `VS Code` extensions

To have the Microsoft Visual Studio Code - Open Source cloud IDE automatically install chosen extensions, you have to add an `extensions.json` file to the remote Git repository that contains your project source code and that will be cloned into workspaces.
To have the Microsoft Visual Studio Code - Open Source IDE automatically install chosen extensions, you have to add an `extensions.json` file to the remote Git repository that contains your project source code and that will be cloned into workspaces.

.Prerequisites
* {prod-short} has network access to the link:https://www.open-vsx.org/[OpenVSX registry].
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[id="setting-up-che-editor-yaml"]
= Setting up che-editor.yaml

By using the `che-editor.yaml` file, you can set a common default IDE for your team and provide new contributors with the most suitable IDE for your project source code. You can also use the `che-editor.yaml` file when you need to set a different cloud IDE default for a particular project repository rather than the default cloud IDE of your organization's {prod-short} instance.
By using the `che-editor.yaml` file, you can set a common default IDE for your team and provide new contributors with the most suitable IDE for your project source code. You can also use the `che-editor.yaml` file when you need to set a different IDE default for a particular project repository rather than the default IDE of your organization's {prod-short} instance.

.Procedure

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[id="parameters-for-che-editor-yaml"]
= Parameters for che-editor.yaml

The simplest way to select a cloud IDE in the `che-editor.yaml` is to specify the `id` of an IDE from the table of supported cloud IDEs:
The simplest way to select an IDE in the `che-editor.yaml` is to specify the `id` of an IDE from the table of supported IDEs:

.Supported cloud IDEs
.Supported IDEs
[cols="1,1a,1a"]
|===
| IDE | `id` | Note
Expand All @@ -13,15 +13,15 @@ include::example$snip_{project-context}-table-of-supported-editors.adoc[]
|===


.`id` selects a cloud IDE from the plugin registry
.`id` selects an IDE from the plugin registry
====
[source,yaml]
----
id: che-incubator/che-idea/latest
----
====

As alternatives to providing the `id` parameter, the `che-editor.yaml` file supports a `reference` to the URL of another `che-editor.yaml` file or an `inline` definition for a cloud IDE outside of a plugin registry:
As alternatives to providing the `id` parameter, the `che-editor.yaml` file supports a `reference` to the URL of another `che-editor.yaml` file or an `inline` definition for an IDE outside of a plugin registry:

.`reference` points to a remote `che-editor.yaml` file
====
Expand All @@ -31,7 +31,7 @@ reference: https://__<hostname_and_path_to_a_remote_file>__/che-editor.yaml
----
====

.`inline` specifies a complete definition for a customized cloud IDE without a plugin registry
.`inline` specifies a complete definition for a customized IDE without a plugin registry
====
[source,yaml]
----
Expand Down Expand Up @@ -81,7 +81,7 @@ registryUrl: __<url_of_custom_plugin_registry>__
<1> The `id` of the IDE in the custom plugin registry.
====

.`override` of the default value of one or more defined properties of the cloud IDE
.`override` of the default value of one or more defined properties of the IDE
====
[source,yaml,subs="+quotes"]
----
Expand Down

0 comments on commit c873b62

Please sign in to comment.