Skip to content

Commit

Permalink
updated doc for creating and configuring a new Che 7 workspace (eclip…
Browse files Browse the repository at this point in the history
…se-che#1364)

Signed-off-by: Oleksii Kurinnyi <[email protected]>
  • Loading branch information
akurinnoy authored Jul 9, 2020
1 parent e376d99 commit 5c0b873
Show file tree
Hide file tree
Showing 6 changed files with 51 additions and 18 deletions.
Binary file added src/main/images/workspaces/minimal-devfile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,41 @@

To add a project to your workspace:

. Click the *Projects* tab, and then click the btn:[Add Project] button.
. Select the type of the project. Choose from: *Samples*, *Blank*, *Git*, *GitHub*, or *Zip*.
. Specify the required details for the project type that you selected, and click the btn:[Add] button.
. Navigate to *Workspaces* page and click the workspace you want to update.
+
image::workspaces/projects-add-project.png[link="{imagesdir}/workspaces/projects-add-project.png"]
Here you have two ways to add a project to your workspace:

. To add another project to the workspace, click the btn:[Add Project] button.
. From the *Projects* tab.

.. Open the *Projects* tab, and then click the btn:[Add Project] button.

.. Choose if you want to import the project by Git URL or from your GitHub account.
+
image::workspaces/che-config-projects-add-git.png[Add Git Project, link="{imagesdir}/workspaces/che-config-projects-add-git.png"]

. From the *Devfile* tab.

.. Open the *Devfile* tab.

.. In the *Devfile editor*, add `projects` section with desired project.
+
image::workspaces/workspace-devfile-editor.png[Edit Devfile Content, link="{imagesdir}/workspaces/workspace-devfile-editor.png"]
+
. After configuring the project for the workspace, check the change in the devfile, which is the configuration file of the workspace, by opening the *Devfile* tab.
[TIP]
.Example: add a project
====
To add a project into the workspace, add or edit the following section:
[source,yaml]
----
projects:
- name: che
source:
type: git
location: 'https://github.com/eclipse/che.git'
----
See the link:{site-baseurl}che-7/making-a-workspace-portable-using-a-devfile/#devfile-reference_making-a-workspace-portable-using-a-devfile[Devfile reference].
====

. Once the project is added, click btn:[Save] button to save this workspace configuration, or click btn:[Apply] button to apply changes to the running workspace.
+
image::workspaces/devfile-tab-to-view.png[link="{imagesdir}/workspaces/devfile-tab-to-view.png"]
image::workspaces/workspace-save-apply-cancel.png[Save Workspace Configuration]
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,24 @@ This procedure describes how to create and edit a new {prod-short} devfile using

To edit the devfile:

. In the *Workspaces* window, click the btn:[Add Workspace] button.
. In the *SELECT STACK* list, select one of the default stacks.
. In the *Workspaces* window, click the btn:[Add Workspace] button. The *Custom Workspace* page should be opened.

. Click the btn:[Create & Proceed Editing] button. The *Workspaces -> Configs* page is shown.
. Scroll down to the *Devfile* section. In the *Devfile editor*, add necessary changes.
+
image::workspaces/workspaces-config-page.png[link="{imagesdir}/workspaces/workspaces-config-page.png"]

. Change the workspace name and click the *Devfile* tab.
+
image::workspaces/workspace-devfile-tab.png[link="{imagesdir}/workspaces/workspace-devfile-tab.png"]

. Delete all the *components* and *commands* in the devfile to get an empty devfile.
image::workspaces/minimal-devfile.png[Devfile editor with the minimal devfile, link="{imagesdir}/workspaces/minimal-devfile.png"]
+
image::workspaces/workspace-empty-devfile.png[]
[TIP]
.Example: add a project
====
To add a project into the workspace, add or edit the following section:
[source,yaml]
----
projects:
- name: che
source:
type: git
location: 'https://github.com/eclipse/che.git'
----
See the link:{site-baseurl}che-7/making-a-workspace-portable-using-a-devfile/#devfile-reference_making-a-workspace-portable-using-a-devfile[Devfile reference].
====

0 comments on commit 5c0b873

Please sign in to comment.