Skip to content

Commit

Permalink
apply fixes to copy
Browse files Browse the repository at this point in the history
remove dupe files
replace/remove images

Change-Id: I10632cbb7b1a1d7ec8d96b469f50073934046e3c
Signed-off-by: nickboldt <[email protected]>
  • Loading branch information
nickboldt committed Jul 2, 2019
1 parent b2cce59 commit 8994cf9
Show file tree
Hide file tree
Showing 14 changed files with 44 additions and 327 deletions.
Binary file modified src/main/images/workspaces/add-blank-project.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 modified src/main/images/workspaces/add-git-project.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 removed src/main/images/workspaces/configure-ram.png
Binary file not shown.
Binary file modified src/main/images/workspaces/select-workpace.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.
Binary file modified src/main/images/workspaces/workspace-config-overview.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 modified src/main/images/workspaces/workspace-config-projects.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 modified src/main/images/workspaces/workspace-config-yaml.png
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 @@ -26,7 +26,6 @@ This paragraph is the assembly introduction. It explains what the user will acco
* Delete the section title and bullets if the assembly has no prerequisites.



include::proc_creating-a-workspace-from-code-sample.adoc[leveloffset=+1]

include::proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc[leveloffset=+1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,13 @@ For a more complete example, see link:https://github.com/eclipse/che/blob/master

* For example, if you're using link:creating-starting-workspaces#minishift[Che inside Minishift]:

* http://che-mini-che.`your.IP.address.here`.nip.io/f?url=link:https://github.com/eclipse/che[https://github.com/eclipse/che]
* http://che-che.`your.IP.address.here`.nip.io/f?url=link:https://github.com/eclipse/che[https://github.com/eclipse/che]

image:workspaces/che-in-che-devfile.png[Che in Che]

. You can also point at a plain text file:

* http://che-mini-che.`your.IP.address.here`.nip.io/f?url=link:https://gist.githubusercontent.com/nickboldt/9551284c2c779a93ccf16bc801416205/raw/7ad1e949880d7f8ed30360e74bb9f8426450db05/devfile.yaml[https://path.to/my/devfile.yaml]
* http://che-che.`your.IP.address.here`.nip.io/f?url=link:https://gist.githubusercontent.com/nickboldt/9551284c2c779a93ccf16bc801416205/raw/7ad1e949880d7f8ed30360e74bb9f8426450db05/devfile.yaml[https://path.to/my/devfile.yaml]

. If you are familiar with link:https://github.com/che-incubator/chectl/[chectl], you can also reference a local devfile.

Expand All @@ -68,12 +68,12 @@ wget https://raw.githubusercontent.com/eclipse/che/master/devfile.yaml -o /tmp/d
```
```
$➔ ./chectl workspace:start --devfile=/tmp/devfile.yaml -n mini-che
✔ Retrieving Che Server URL...http://che-mini-che.`your.IP.address.here`.nip.io
✔ Retrieving Che Server URL...http://che-che.`your.IP.address.here`.nip.io
✔ Verify if Che server is running
✔ Create workspace from Devfile /tmp/devfile.yaml

Workspace IDE URL:
http://che-mini-che.`your.IP.address.here`.nip.io/dashboard/#/ide/che/che-in-che
http://che-che.`your.IP.address.here`.nip.io/dashboard/#/ide/che/che-in-che

```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@

This section is about how to create a new workspace to edit an existing codebase. There are 3 ways to do that:

* xref:creating-a-workspace-from-code-sample_{context}#change-the-workspace-configuration[Select a stack from the User Dashboard but change the project]
* Add a devfile to a git repository and starting the workspace using chectl or a factory
* Import a project in a running workspace from the editor
* xref:#configure-devfile[Select a stack from the User Dashboard, then change the devfile] to include your project
* Add a devfile to a git repository and start the workspace using chectl or a factory
* Import a project into a running workspace from the editor

[discrete]
== Prerequisites
Expand All @@ -14,11 +14,11 @@ This section is about how to create a new workspace to edit an existing codebase
* Or, you need a Kubernetes cluster such as link:https://github.com/kubernetes/minikube#installation[Minikube] to use Che on Kubernetes.

[discrete]
== Importing from the dashboard
== Importing from the dashboard (existing workspace)

There are at least two ways to import a project via the User Dashboard.

From the User Dashboard, select Workspaces, then select your workspace by clicking on its name, or use the gear icon. The former will link you to the workspace's *Overview* tab, while the latter will link to the *Config* tab where you can enter your own YAML configuration.
From the User Dashboard, select Workspaces, then select your workspace by clicking on its name, or use the gear icon. The former will link you to the workspace's *Overview* tab, while the latter will link to the *Devfile* tab where you can enter your own YAML configuration.

In either case, click the *Projects* tab next.

Expand Down Expand Up @@ -55,9 +55,9 @@ image::workspaces/open-git-project.png[Your git project]

Once you have a project, you can add commands to it. This allows you to more easily run, debug, or launch your application in a browser.

You can do this via the workpace's *Config* tab:
You can do this via the workpace's *Devfile* tab:

image::workspaces/workspace-config-add-commands.png[Add commands to workspace]
image::workspaces/workspace-config-yaml.png[Add commands to workspace]

Then inside the workspace, use run a command from the menu *Terminal* > *Run Task...*.

Expand All @@ -69,7 +69,7 @@ image::workspaces/configure-command.png[Configure tasks]

== Importing to a running workspace with `git clone` command

In addition to the approach above, where you can add projects via your workspace's *Projects* or *Config* tab, you can simply start a workspace, and use `git clone` from the command palette.
In addition to the approach above, where you can add projects via your workspace's *Projects* or *Devfile* tab, you can simply start a workspace, and use `git clone` from the command palette.

image::workspaces/welcome.png[Welcome screen]

Expand All @@ -83,13 +83,13 @@ image::workspaces/git-clone-command-2.png[Configure git clone command]

== Importing to a running workspace with `git clone` in a terminal

In addition to the approach above, where you can add projects via your workspace's *Projects* or *Config* tab, you can simply start a workspace, open a *Terminal*, and use `git clone` to pull code.
In addition to the approach above, where you can add projects via your workspace's *Projects* or *Devfile* tab, you can simply start a workspace, open a *Terminal*, and use `git clone` to pull code.

image::workspaces/git-clone-terminal.png[Run git clone in a terminal]

Note that while this approach will store code in the workspace, it will NOT update the workspace's configuration, so you will NOT see projects imported this way in the *Projects* or *Config* tab.
Note that while this approach will store code in the workspace, it will NOT update the workspace's configuration, so you will NOT see projects imported this way in the *Projects* or *Devfile* tab.

Similarly, if you delete a project, that you previously added via the User Dashboard, from the workspace with `rm -fr myproject`, it may still appear in the *Projects* or *Config* tab.
Similarly, if you delete a project, that you previously added via the User Dashboard, from the workspace with `rm -fr myproject`, it may still appear in the *Projects* or *Devfile* tab.

[discrete]
== Additional resources
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,18 @@ It will also explain how to customize a workspace using the User Dashboard.

[NOTE]
====
Every new devfile based stack should link:https://github.com/eclipse/che/issues/13529[come with one sample codebase].
Every stack comes with one sample codebase, as defined by the stack's devfile. For more on devfiles, see xref:configuring-a-che-workspace-using-a-devfile_{context}[Configuring a Che workspace using a Devfile].
====

[discrete]
== Prerequisites

* You need an OKD, OCP, or OSD cluster, if using Che on Openshift. See below for use of link:https://www.okd.io/minishift/[Minishift].
* You need an OKD (link:https://www.okd.io/minishift/[Minishift]), OCP, or OSD cluster, if using Che on Openshift.

* Or, you need a Kubernetes cluster such as link:https://github.com/kubernetes/minikube#installation[Minikube] to use Che on Kubernetes.

* To install on Minishift or Minikube, see xref:che-quick-starts#deploying-che-using-chectl[Deploying Che using chectl].

[discrete]
== Procedure

Expand All @@ -25,14 +28,14 @@ The dashboard is accessible on your cluster from a URL like http://`che-instance

==== Minishift

If you are using link:https://www.okd.io/minishift/[Minishift], you can use the Che add-on to automatically deploy Che to your Minishift (OKD) instance.
See xref:che-quick-starts#deploying-che-using-chectl[Deploying Che using chectl].

[NOTE]
====
For versions of link:https://github.com/minishift/minishift/releases[Minishift up to 1.34], you need to apply a small change:
```
minishift --profile che addons apply --addon-env PLUGIN__REGISTRY__URL=https://che-plugin-registry.openshift.io/v3 che
oc set env dc/che CHE_WORKSPACE_PLUGIN__REGISTRY__URL=https://che-plugin-registry.openshift.io/v3
```
====

Expand All @@ -44,34 +47,24 @@ minishift --profile che addons apply --addon-env PLUGIN__REGISTRY__URL=https://c

. Then click through to the mini-che route link, which will load the dashboard by default and prompt you to create a workspace.

* http://che-mini-che.`your.IP.address.here`.nip.io/
* http://che-che.`your.IP.address.here`.nip.io/

==== OCP and OSD

If using OCP or OSD, talk to your administrator to obtain the URL for the che instance.

=== Selecting a Stack
=== Selecting a stack

Choose a stack from the list. Note that only stacks marked with Che 7 are fully compatible with Che 7 server, but the older Che 6 based ones may still work.
Choose a stack from the list.

image::workspaces/select-workpace.png[Select a stack from the list]

=== Reviewing the compute resource limits
=== Viewing the compute resource limits

Depending on the type of stack and what you need to do, you may want to allocate more or less RAM to the workspace. The minimum recommended memory is already set.
The memory needed by the stack is pre-calculated and displayed on the stack description line. Changing the memory requirements is only possible from the devfile.

image::workspaces/configure-ram.png[Configure Workpace RAM]

=== Choosing sample project(s)

Below the list of stacks you can choose which sample project(s) to include in your new workspace. Simply check the boxes next to the project(s) you want to include.

image::workspaces/choose-sample-project.png[Choose sample project]

Don't forget to click the *Add* button to add the project to the workspace!

image::workspaces/add-sample-project.png[Add project to workspace]

=== Start the workspace

There are two ways to start the workspace:
Expand All @@ -88,25 +81,33 @@ image::workspaces/create-and-edit.png[Create and Edit]

If you chose the second option, you'll be able to configure the workspace's YAML, among other tasks:

. From the *Overview* tab, you can quickly rename a workspace, if you forgot to do that when creating it. You can also toggle ephemeral mode, or export your workspace config to a file or private cloud. This is also once place where you can delete a workspace.
. From the *Overview* tab, you can quickly rename a workspace, if you forgot to do that when creating it. You can also toggle ephemeral mode, or export your workspace config to a file or private cloud. This is also one of serveral places from which you can delete a workspace.
+
image::workspaces/workspace-config-overview.png[Worksapce configuration overview]

. From the *Projects* tab, you can add more projects to an existing workspace:
+
image::workspaces/workspace-config-projects.png[Add projects to workspace]

. From the *Containers* tab, you can change RAM allocation or add a new container.
. From the *Servers* tab, add or change servers.
. From the *Env Variables* tab, add ot change environment variables in your workspace.
. From the *Volumes* tab, configure persistent storage volumes.
. From the *Config* tag, you can edit your workspace's YAML configuration. This is also where you can load a custom container, if you previously built one and pushed it to some container registry. You can also add commands, sample projects, and more, if you prefer to enter code than to click buttons.
. From the *Plugins* tab, you can enable/disable workspace plugins. For example, you could start with a generic Java-based stack but later add support for Node or Python.

. From the *Editors* tab, you can enable/disable workspace editors. For example, if you wanted to switch to the Che 6 editor, you could select the GWT IDE instead of the Che 7 editor, based on Theia.

[id="configure-devfile"]
[start=5]
. From the *Devfile* tag, you can edit your workspace's YAML configuration. This is also where you can load a custom container, if you previously built one and pushed it to some container registry. You can also add commands, sample projects, and more, if you prefer to enter code than to click buttons.
+
image::workspaces/workspace-config-yaml.png[YAML configuration]

. From the *SSH* tab, you can log into a running workpace.
. From the *Plugins* tab, you can enable/disable workspace plugins. For example, you could start with a generic Java-based stack but later add support for Node or Python.
. From the *Editors* tab, you can enable/disable workspace editors. For example, if you wanted to switch to the Che 6 editor, you could select the GWT IDE instead of the Che 7 editor, based on Theia.
For example, to add a project into the workspace, add or edit this section:

```
projects:
- name: che
source:
type: git
location: 'https://github.com/eclipse/che.git'
```

=== Running a workspace

Expand Down

This file was deleted.

Loading

0 comments on commit 8994cf9

Please sign in to comment.