-
Notifications
You must be signed in to change notification settings - Fork 169
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
format, language and structure about Hosted Che (#1)
* format, language and structure about Hosted Che Signed-off-by: Fabrice Flore-Thébault <[email protected]> * FAQ belongs to rh-che repository Signed-off-by: Fabrice Flore-Thébault <[email protected]> * review Hosted Che documentation Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Update src/main/pages/che-7/overview/assembly_hosted-che.adoc Co-Authored-By: Robert Kratky <[email protected]> * Update src/main/pages/che-7/overview/proc_creating_workspace_from_template_in_hosted_che.adoc Co-Authored-By: Robert Kratky <[email protected]> * Update src/main/pages/che-7/overview/ref_hosted_che_faq.adoc Co-Authored-By: Robert Kratky <[email protected]> * Update src/main/pages/che-7/overview/proc_linking_github_account_in_hosted_che.adoc Co-Authored-By: Robert Kratky <[email protected]> * Update src/main/pages/che-7/overview/proc_linking_github_account_in_hosted_che.adoc Co-Authored-By: Robert Kratky <[email protected]> * Update src/main/pages/che-7/overview/proc_linking_github_account_in_hosted_che.adoc Co-Authored-By: Robert Kratky <[email protected]> * Update src/main/pages/che-7/overview/proc_registering_to_hosted_che.adoc Co-Authored-By: Robert Kratky <[email protected]> * Update src/main/pages/che-7/overview/proc_registering_to_hosted_che.adoc Co-Authored-By: Robert Kratky <[email protected]> * Update src/main/pages/che-7/overview/ref_about_hosted_che.adoc Co-Authored-By: Robert Kratky <[email protected]> * Update src/main/pages/che-7/overview/ref_about_hosted_che.adoc Co-Authored-By: Robert Kratky <[email protected]> * Review Hosted Che. Integrate comments from @rkratky Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Update src/main/pages/che-7/overview/proc_importing-projects-from-github-in-hosted-che.adoc Co-Authored-By: Robert Kratky <[email protected]> * Update src/main/pages/che-7/overview/proc_creating-a-worskpace-from-the-user-dashboard.adoc Co-Authored-By: Robert Kratky <[email protected]> * Review Hosted Che. Integrate comments from @rkratky Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Update src/main/pages/che-7/overview/proc_creating-a-worskpace-from-the-user-dashboard.adoc Co-Authored-By: Robert Kratky <[email protected]> * Update src/main/pages/che-7/overview/ref_about-hosted-che.adoc Co-Authored-By: Robert Kratky <[email protected]> * Update src/main/pages/che-7/overview/ref_about-hosted-che.adoc Co-Authored-By: Robert Kratky <[email protected]> * Update src/main/pages/che-7/overview/proc_creating-a-worskpace-from-the-user-dashboard.adoc Co-Authored-By: Robert Kratky <[email protected]> * Update src/main/pages/che-7/overview/proc_creating-a-worskpace-from-the-user-dashboard.adoc Co-Authored-By: Robert Kratky <[email protected]> * Update src/main/pages/che-7/overview/proc_creating-a-worskpace-from-the-user-dashboard.adoc Co-Authored-By: Robert Kratky <[email protected]> * Update src/main/pages/che-7/overview/proc_importing-projects-from-github-in-hosted-che.adoc Co-Authored-By: Robert Kratky <[email protected]> * Update src/main/pages/che-7/overview/proc_importing-projects-from-github-in-hosted-che.adoc Co-Authored-By: Robert Kratky <[email protected]> * Update src/main/pages/che-7/overview/proc_importing-projects-from-github-in-hosted-che.adoc Co-Authored-By: Robert Kratky <[email protected]> * Update src/main/pages/che-7/overview/proc_importing-projects-from-github-in-hosted-che.adoc Co-Authored-By: Robert Kratky <[email protected]> * Review Hosted Che. Integrate comments from @rkratky Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Review Hosted Che. Integrate comments from @rkratky Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Update src/main/pages/che-7/overview/proc_creating-a-workspace-from-template-in-hosted-che.adoc Co-Authored-By: Robert Kratky <[email protected]> * Update src/main/pages/che-7/overview/proc_contributing-to-github-projects-in-hosted-che.adoc Co-Authored-By: Robert Kratky <[email protected]> * fix broken links Signed-off-by: Fabrice Flore-Thébault <[email protected]>
- Loading branch information
Showing
13 changed files
with
238 additions
and
99 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
30 changes: 30 additions & 0 deletions
30
...in/pages/che-7/overview/proc_contributing-to-github-projects-in-hosted-che.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // assembly_hosted-che.adoc | ||
|
|
||
| // This module can be included from assemblies using the following include statement: | ||
| // include::proc_contributing-to-github-projects-in-hosted-che.adoc[leveloffset=+1] | ||
|
|
||
| [id="contributing-to-github-projects-in-hosted-che_{context}"] | ||
| = Contributing to GitHub projects in Hosted Che | ||
|
|
||
| This section describes how to contribute to GitHub projects in Hosted Che. | ||
|
|
||
| [discrete] | ||
| == Prerequisites | ||
|
|
||
| * A workspace running in Hosted{nbsp}Che, including a project imported from GitHub. See link:hosted-che.html#importing-projects-from-github-in-hosted-che_{context}[Importing projects from GitHub in Hosted{nbsp}Che]. | ||
|
|
||
| * The link:https://github.com/eclipse/che-theia/tree/master/plugins/ssh-plugin[SSH Plug-in] is installed in the workspace. | ||
|
|
||
| [discrete] | ||
| == Procedure | ||
|
|
||
| . Generate an SSH key pair with the link:https://github.com/eclipse/che-theia/tree/master/plugins/ssh-plugin[SSH Plug-in]. | ||
|
|
||
| . Upload the public key to the GitHub account following the link:https://help.github.com/en/articles/adding-a-new-ssh-key-to-your-github-account[Adding a new SSH key to your GitHub account] procedure. | ||
|
|
||
| [discrete] | ||
| == Additional resources | ||
|
|
||
| * To learn more, see link:end-user-tasks.html#configuring-your-vcs-credentials-for-your-workspaces_end-user-tasks[Configuring your VCS credentials for your workspaces]. |
31 changes: 31 additions & 0 deletions
31
...pages/che-7/overview/proc_creating-a-workspace-from-template-in-hosted-che.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // assembly_hosted-che.adoc | ||
|
|
||
| // This module can be included from assemblies using the following include statement: | ||
| // include::proc_creating-a-workspace-from-template-in-hosted-che.adoc[leveloffset=+1] | ||
|
|
||
| [id="creating-a-workspace-from-template-in-hosted-che_{context}"] | ||
| = Creating a workspace from a template in Hosted Che | ||
|
|
||
| This section describes how to create a workspace from a predefined link:https://www.eclipse.org/che/getting-started/cloud/[template]. | ||
|
|
||
| Various programming languages and frameworks are supported. | ||
|
|
||
| [discrete] | ||
| == Prerequisites | ||
|
|
||
| * Existing Hosted{nbsp}Che account. See link:hosted-che.html#registering-to-hosted-che_{context}[Registering to Hosted{nbsp}Che]. | ||
|
|
||
| [discrete] | ||
| == Procedure | ||
|
|
||
| . Navigate to the link:https://www.eclipse.org/che/getting-started/cloud/[templates registry]. | ||
|
|
||
| . Choose the desired flavor. | ||
|
|
||
| . Click the btn:[Launch Workspace] button. | ||
|
|
||
| . The workspace is created and displayed in Hosted{nbsp}Che. | ||
|
|
||
| image::hosted-che/getting-started-devfile.png[] |
38 changes: 38 additions & 0 deletions
38
...ain/pages/che-7/overview/proc_creating-a-worskpace-from-the-user-dashboard.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // assembly_hosted-che.adoc | ||
|
|
||
| // This module can be included from assemblies using the following include statement: | ||
| // include::<path>/proc_creating-a-worskpace-from-the-user-dashboard.adoc[leveloffset=+1] | ||
|
|
||
| [id="creating-a-worskpace-from-the-user-dashboard_{context}"] | ||
| = Creating a worskpace from the user dashboard | ||
|
|
||
| This section describes how to create a workspace from the user dashboard in Hosted{nbsp}Che. | ||
|
|
||
| [discrete] | ||
| == Prerequisites | ||
|
|
||
| * Existing Hosted{nbsp}Che account. See link:hosted-che.html#registering-to-hosted-che_{context}[Registering to Hosted{nbsp}Che]. | ||
|
|
||
| [discrete] | ||
| == Procedure | ||
|
|
||
| . Navigate to the link:https://che.openshift.io/dashboard/[Hosted{nbsp}Che user dashboard]. | ||
|
|
||
| . Click the btn:[Create Workspace] button. | ||
|
|
||
| . Define a *Name* for the workspace. A generated name is proposed. It can be modified. | ||
|
|
||
| . In the *Stack* section, select the workspace runtime environment that will be used to build and run projects from the list. | ||
|
|
||
| . In the *RAM* section, adapt the memory available for the workspace runtime environment within the limits defined in the link:hosted-che.html#terms-of-service_{context}[terms of service]. | ||
|
|
||
| . In the *Ephemeral mode* section, choose to have persistent storage attached or not. | ||
|
|
||
| . In the *Projects* section, choose the projects to integrate in the workspace. For the specific GitHub case, see link:#importing-projects-from-github-in-hosted-che_{context}[Importing projects from GitHub in Hosted Che]. | ||
|
|
||
| [discrete] | ||
| == Additional resources | ||
|
|
||
| * For more details, see link:using-developer-environments-workspaces.html[Using developer environments - workspaces]. |
39 changes: 39 additions & 0 deletions
39
...ain/pages/che-7/overview/proc_importing-projects-from-github-in-hosted-che.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // assembly_hosted-che.adoc | ||
|
|
||
| // This module can be included from assemblies using the following include statement: | ||
| // include::<path>/proc_importing-projects-from-github-in-hosted-che.adoc[leveloffset=+1] | ||
|
|
||
| [id="importing-projects-from-github-in-hosted-che_{context}"] | ||
| = Importing projects from GitHub in Hosted Che | ||
|
|
||
| This section describes how to import a GitHub project in Hosted Che. | ||
|
|
||
| This action can be done during the creation of a new workspace, or later, on an existing workspace. | ||
|
|
||
| [discrete] | ||
| == Prerequisites | ||
|
|
||
| * Existing Hosted{nbsp}Che account. See link:hosted-che.html#registering-to-hosted-che_{context}[Registering to Hosted{nbsp}Che]. | ||
|
|
||
| * Existing GitHub account. | ||
|
|
||
| [discrete] | ||
| == Procedure | ||
|
|
||
| . Navigate to the *Projects* section of the *New Workspace* creation screen. | ||
| + | ||
| Alternatively if the workspace is already existing, navigate to the *Projects* section of the *Configure Workspace* screen. | ||
|
|
||
| . Click the btn:[Add Project] button. | ||
|
|
||
| . Navigate to the *GitHub* tab. | ||
|
|
||
| . Click the btn:[Connect your GitHub account] button. | ||
|
|
||
| . In the popup, review the settings and click the btn:[Authorize openshiftio] button. | ||
|
|
||
| . Type in the password as requested and click the btn:[Confirm password] button. | ||
|
|
||
| . Select the desired repositories and click the btn:[Add] button. |
28 changes: 28 additions & 0 deletions
28
src/main/pages/che-7/overview/proc_registering-to-hosted-che.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // assembly_hosted-che.adoc | ||
|
|
||
| [id="registering-to-hosted-che_{context}"] | ||
| = Registering to Hosted{nbsp}Che | ||
|
|
||
| This section describes how to register to Hosted{nbsp}Che. | ||
|
|
||
| [discrete] | ||
| == Prerequisites | ||
|
|
||
| * Existing OpenShift{nbsp}Online, Red{nbsp}Hat Developer{nbsp}Program, or Red{nbsp}Hat Customer{nbsp}Portal account. | ||
|
|
||
| [discrete] | ||
| == Procedure | ||
|
|
||
| . Navigate to link:https://che.openshift.io/[Hosted{nbsp}Che]. | ||
|
|
||
| . Log in with the existing OpenShift{nbsp}Online, Red{nbsp}Hat Developer{nbsp}Program, or Red{nbsp}Hat Customer{nbsp}Portal account. | ||
|
|
||
| . Click the btn:[Activate account] button. | ||
|
|
||
| . Wait for an email with a link to connect to the Eclipse{nbsp}Che instance. It is sent once the environment is ready for use. | ||
|
|
||
| . Follow the *Get Started* link in the email. | ||
|
|
||
| . The Hosted{nbsp}Che user dashboard is displayed. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // assembly_hosted-che.adoc | ||
|
|
||
| // This module can be included from assemblies using the following include statement: | ||
| // include::proc_about-hosted-che.adoc[leveloffset=+1] | ||
|
|
||
| [id="about-hosted-che_{context}"] | ||
| = About Hosted Che | ||
|
|
||
| Hosted{nbsp}Che is link:https://www.eclipse.org/che/[Eclipse{nbsp}Che] hosted by Red{nbsp}Hat. | ||
| A Che server is running on OpenShift{nbsp}Dedicated, and the user base is spread across multiple OpenShift{nbsp}Online clusters where workspaces are created. | ||
|
|
||
| [id="terms-of-service_{context}"] | ||
| == Terms of service | ||
|
|
||
| Hosted{nbsp}Che has the following usage limits and terms of service: | ||
|
|
||
| * Storage: 1 GB | ||
| * RAM: 3 GB | ||
| * CPU: 6 Cores | ||
| * Concurrent workspaces: 1 | ||
| * Number of workspaces: unlimited | ||
| * Number of projects per workspace: unlimited | ||
| * Usage time limit: none | ||
| * Maximum account inactivity period: 30 days | ||
| + | ||
| [NOTE] | ||
| ==== | ||
| Hosted{nbsp}Che automatically deprovisions accounts that have been inactive for more than 30 days. All existing workspaces in a deprovisioned account are lost. | ||
| To start using Hosted{nbsp}Che again, a user needs to re-register. | ||
| ==== | ||
| * Workspace idling time: 15 minutes | ||
| + | ||
| [NOTE] | ||
| ==== | ||
| A started workspace can be used for an unlimited period of time. | ||
| When there are no interactions with the IDE, the workspace is stopped after 15 minutes. | ||
| ==== | ||
| * Ephemeral mode: defaults to *Active* | ||
| + | ||
| [NOTE] | ||
| ==== | ||
| In ephemeral mode, workspaces have no persistent storage attached. | ||
| All content changes are lost when the workspace is stopped unless they are pushed to a source-code repository first. | ||
| This is done to improve the performance of workspace starts and file-system operations in the IDE. | ||
| It is possible to disable ephemeral mode while link:hosted-che.html#creating-a-worskpace-from-the-user-dashboard_{context}[creating a workspace from the user dashboard]. | ||
| For more information about ephemeral mode, including how to disable it after workspace creation, see link:using-developer-environments-workspaces.html[Using developer environments - workspaces TODO]. | ||
| ==== |