Skip to content

Fix heading levels and reorganize "Creating a workspace from code sample" #782

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 19, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/main/_data/sidebars/che_7_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ entries:
url: che-7/introduction-to-eclipse-che
output: web
- title: Che quick-starts
#url: che-7/che-quick-starts
output: web
folderitems:
- title: Installing the chectl management tool
Expand Down Expand Up @@ -50,6 +51,9 @@ entries:

- title: End-user Guide
folders:
- title: "Navigating Che: dashboard"
url: che-7/navigating-che-using-the-dashboard
output: web
- title: Che-Theia IDE basics
output: web
folderitems:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,24 +0,0 @@
[id="developing-che-monitoring-metrics_{context}"]
= Developing Che monitoring metrics

This paragraph is the procedure module introduction: a short description of the procedure.

.Prerequisites

* A bulleted list of conditions that must be satisfied before the user starts following this assembly.
* You can also link to other modules or assemblies the user must follow before starting this assembly.
* Delete the section title and bullets if the assembly has no prerequisites.

.Procedure

. Start each step with an active verb.

. Include one command or action per step.

. Use an unnumbered bullet (*) if the procedure includes only one step.

.Additional resources

* A bulleted list of links to other material closely related to the contents of the procedure module.
* For more details on writing procedure modules, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
* Use a consistent system for file names, IDs, and titles. For tips, see _Anchor Names and File Names_ in link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
Original file line number Diff line number Diff line change
@@ -1,24 +0,0 @@
[id="removing-user-data_{context}"]
= Removing user data

This paragraph is the procedure module introduction: a short description of the procedure.

.Prerequisites

* A bulleted list of conditions that must be satisfied before the user starts following this assembly.
* You can also link to other modules or assemblies the user must follow before starting this assembly.
* Delete the section title and bullets if the assembly has no prerequisites.

.Procedure

. Start each step with an active verb.

. Include one command or action per step.

. Use an unnumbered bullet (*) if the procedure includes only one step.

.Additional resources

* A bulleted list of links to other material closely related to the contents of the procedure module.
* For more details on writing procedure modules, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
* Use a consistent system for file names, IDs, and titles. For tips, see _Anchor Names and File Names_ in link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
Original file line number Diff line number Diff line change
@@ -1,24 +0,0 @@
[id="viewing-che-operator-logs_{context}"]
= Viewing Che Operator logs

This paragraph is the procedure module introduction: a short description of the procedure.

.Prerequisites

* A bulleted list of conditions that must be satisfied before the user starts following this assembly.
* You can also link to other modules or assemblies the user must follow before starting this assembly.
* Delete the section title and bullets if the assembly has no prerequisites.

.Procedure

. Start each step with an active verb.

. Include one command or action per step.

. Use an unnumbered bullet (*) if the procedure includes only one step.

.Additional resources

* A bulleted list of links to other material closely related to the contents of the procedure module.
* For more details on writing procedure modules, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
* Use a consistent system for file names, IDs, and titles. For tips, see _Anchor Names and File Names_ in link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This section describes how to add support for a new language into Eclipse Che.
The described method is to write a Che-Theia plug-in that uses the _languageserver-node_ library to connect a language server to the VS Code extension API. Note that it is also possible to directly connect a Che-Theia plug-in or a VS Code extension to the plug-in API.

.Prerequisites
* Install the latest Che-Theia plug-in Yeoman generator. Follow the documentation about link:{{site.baseurl}}che-7/developing-che-theia-plug-ins[how to develop Che-Theia plug-in with Yeoman].
* Install the latest Che-Theia plug-in Yeoman generator. Follow the documentation about link:{site-baseurl}che-7/developing-che-theia-plug-ins[how to develop Che-Theia plug-in with Yeoman].

.Procedure

Expand All @@ -39,4 +39,4 @@ The described method is to write a Che-Theia plug-in that uses the _languageserv
* link:https://microsoft.github.io/language-server-protocol/[Language Server Protocol]
* link:https://code.visualstudio.com/api/language-extensions/overview[VS Code Language Extensions Documentation]
* link:https://code.visualstudio.com/api/language-extensions/language-server-extension-guide[A simple Language Server for plain text files]
* link:{{site.baseurl}}che-7/publishing-che-theia-plug-ins/#adding-a-che-theia-plug-in-to-the-che-plug-in-registry_publishing-che-theia-plug-ins[Add the plug-in to the Che plug-in registry]
* link:{site-baseurl}che-7/publishing-che-theia-plug-ins/#adding-a-che-theia-plug-in-to-the-che-plug-in-registry_publishing-che-theia-plug-ins[Add the plug-in to the Che plug-in registry]
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Creating a workspace from code sample
keywords:
tags: []
sidebar: che_7_docs
permalink: che-7/creating-a-workspace-from-code-sample/
folder: che-7/end-user-guide
summary:
---

:parent-context-of-creating-a-workspace-from-code-sample: {context}

[id='creating-a-workspace-from-code-sample_{context}']
= Creating a workspace from code sample

:context: creating-a-workspace-from-code-sample

Every stack includes a sample codebase, which is defined by the devfile of the stack.
This section explains how to create a workspace from this code sample in a sequence of three procedures.

. xref:creating-a-workspace-from-user-dashboard_{context}[Creating a workspace from the user dashboard].
. xref:changing-the-configuration-of-an-existing-workspace-from-the-user-dashboard_{context}[Changing the configuration of the workspace] to add code sample.
. xref:running-an-existing-workspace-from-the-user-dashboard_{context}[Running an existing workspace from the user dashboard].

For more information on devfiles, see link:{site-baseurl}che-7/configuring-a-workspace-using-a-devfile/[Configuring a Che workspace using a devfile].

include::proc_creating-a-workspace-from-user-dashboard.adoc[leveloffset=+1]

include::proc_changing-the-configuration-of-an-existing-workspace-from-the-user-dashboard.adoc[leveloffset=+1]

include::assembly_running-an-existing-workspace-from-the-user-dashboard.adoc[leveloffset=+1]

:context: {parent-context-of-creating-a-workspace-from-code-sample}
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Remotely accessing workspaces
keywords:
tags: []
sidebar: che_7_docs
permalink: che-7/remotely-accessing-workspaces/
permalink: che-7/remotely-accessing-che-workspaces/
folder: che-7/end-user-guide
summary:
---
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
:parent-context-of-running-an-existing-workspace-from-the-user-dashboard: {context}

[id='running-an-existing-workspace-from-the-user-dashboard_{context}']
= Running an existing workspace from the User Dashboard

:context: running-an-existing-workspace-from-the-user-dashboard

This section describes how to run an existing workspace from the User Dasboard

include::proc_running-an-existing-workspace-from-the-user-dashboard-using-the-run-button.adoc[leveloffset=+1]

include::proc_running-an-existing-workspace-from-the-user-dashboard-using-the-open-button.adoc[leveloffset=+1]

include::proc_running-an-existing-workspace-from-the-user-dashboard-using-the-recent-workspaces.adoc[leveloffset=+1]

:context: {parent-context-of-running-an-existing-workspace-from-the-user-dashboard}
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ include::assembly_importing-a-kubernetes-application-into-a-workspace.adoc[level

include::assembly_remotely-accessing-workspaces.adoc[leveloffset=+1]

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

include::proc_creating-a-workspace-by-importing-source-code-of-a-project.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Che-Theia plug-ins have the following capabilities:

A Che-Theia plug-in can be based on a VS Code extension or an Eclipse Theia plug-in.

A Visual Studio Code extension:: To repackage a VS Code extension as a Che-Theia plug-in with its own set of dependencies, package the dependencies into a container. This ensures that Eclipse Che users do not need to install the dependencies when using the extension. See link:{{site.baseurl}}che-7/using-a-visual-studio-code-extension-in-che[Using a Visual Studio Code extension in Che].
A Visual Studio Code extension:: To repackage a VS Code extension as a Che-Theia plug-in with its own set of dependencies, package the dependencies into a container. This ensures that Eclipse Che users do not need to install the dependencies when using the extension. See link:{site-baseurl}che-7/using-a-visual-studio-code-extension-in-che[Using a Visual Studio Code extension in Che].

An Eclipse Theia plug-in:: You can build a Che-Theia plug-in by implementing an Eclipse Theia plug-in and packaging it to Eclipse Che.
// TODO: Learn more about how to package a Che-Theia plug-in at link:[LINK].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Examples:
* New set of commands
* New UI components

To include a Che-Theia plug-in as embedded, define a URL to the plug-in binary (the `.theia` archive) in the `meta.yaml` file. In the case of a VS Code extension, provide the extension ID from the Visual Studio Code marketplace (see link:{{site.baseurl}}che-7/using-a-visual-studio-code-extension-in-che[Using a Visual Studio Code extension in Che]).
To include a Che-Theia plug-in as embedded, define a URL to the plug-in binary (the `.theia` archive) in the `meta.yaml` file. In the case of a VS Code extension, provide the extension ID from the Visual Studio Code marketplace (see link:{site-baseurl}che-7/using-a-visual-studio-code-extension-in-che[Using a Visual Studio Code extension in Che]).

When starting a workspace, Che downloads and unpacks the plug-in binaries and includes them in the Che-Theia editor container. The Che-Theia editor initializes the plug-ins when it starts.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
[id='changing-the-configuration-of-an-existing-workspace-from-the-user-dashboard_{context}']
= Changing the configuration of an existing workspace from the User Dashboard

This section describes how to change the configuration of an existing workspace from the User Dashboard.

[discrete]
== Prerequisites

* A running instance of Eclipse Che. To install an instance of Eclipse Che see link:{site-baseurl}che-7/che-quick-starts/[Che quick starts].

* An existing workspace defined on this instance of Eclipse Che xref:creating-a-workspace-from-user-dashboard_{context}[Creating a workspace from user dashboard].

[discrete]
== Procedure

. Navigate to the Che Dashboard. See link:{site-baseurl}che-7/navigating-che-using-the-dashboard/[Navigating Che using the dashboard].

. In the left navigation panel, navigate to *Workspaces*.

. Click on the name of a workspace to navigate to the configuration overview page.

. Click on the *Overview* tab, to execute following actions:

** Change the *Workspace name*.

** Toggle *Ephemeral mode*.

** *Export* the workspace configuration to a file or private cloud.

** *Delete* the workspace.
+
image::workspaces/workspace-config-overview.png[Worksapce configuration overview]

// TODO https://github.com/eclipse/che/issues/13665 fix screenshot

. In the *Projects* section, choose the projects to integrate in the workspace.

.. Click on the btn:[Add Project] button

.. Select the projects to integrate in the workspace.

.. Click on th btn:[Add] button.
+
image::workspaces/workspace-config-projects.png[Add projects to workspace]
+

. In the *Plugins* section, choose the plugins to integrate in the workspace.
+
[TIP]
.Example
====
Start with a generic Java-based stack, then later add support for Node or Python.
====

. In the *Editors* section, choose the editors to integrate in the workspace. The Che 7 editor is based on Theia.
+
[TIP]
.Example: Switch to the Che 6 editor
====
* To Switch to the Che 6 editor, select the GWT IDE.
====

[id="configure-devfile"]
[start=5]
. From the *Devfile* tab, edit the workspace's YAML configuration. See link:{site-baseurl}che-7/making-a-workspace-portable-using-a-devfile/#devfile-reference_making-a-workspace-portable-using-a-devfile[Devfile reference].
+
[TIP]
.Example: add commands
====
image::workspaces/workspace-config-yaml.png[YAML configuration]
====
+
[TIP]
.Example: add a project
====
To add a project into the workspace, add or edit the following section:

```
projects:
- name: che
source:
type: git
location: 'https://github.com/eclipse/che.git'
```
====
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
[id="configuring-a-new-workspace-from-user-dashboard_{context}"]
= Configuring a new workspace from User Dashboard

This section describes how to configure a new workspace from User Dashboard as a last step of the workspace creation.

[discrete]
== Prerequisites

* Follow the link:using-developer-environments-workspaces.html#creating-a-workspace-from-user-dashboard_{context}[Creating a workspace from User Dashboard] procedure.

[discrete]
== Procedure

. At the top of the page, click the down arrow next to the *Create & Open* button.

. Click on the *Create & Edit* menu item.

. The workspace configuration page is displayed.
+
image::workspaces/create-and-edit.png[Create and Edit]
Loading