-
Task
-
Resolution: Unresolved
-
Normal
-
None
-
devex docs #234 Mar 30-Apr 6, devex docs #247 Oct 5-Oct 26, devex docs #248 Oct 26-Nov 16, devex docs #249 Nov 16-Dec 7, devex docs #250 Dec 7-Dec 28, devex docs #251 Jan 2-Jan 23, devex docs #252 Jan 23-Feb 12, devex docs #253 Feb 12-Mar 4
-
8
We need to explain to project maintainers who never tried Che before how they can explore Che and how Che will be useful to their project and how it will impact their project.
I proposed this to be a substitute for the content until now labeled as "Contributing for the first time to a project". The reason for this is because there are two situations where newcomers to Che can try it:
A. Newcomers to Che who do not have their project using Che, and this we should aim at project maintainers because they are the stakeholders most relevant to exploring Che. This is the audience for the section Adopting Che.
How a maintainer of a project can setup his project to use Che
- As a prereq, find a Che instance of your liking *
- Add a badge to the project README file with a Che link to start a universal workspace
- Add a .devfile.yaml at the root of the project to customize components and commands
- Add a .vscode/extensions.json at the root of the project to include some VS Code extensions in Theia or VS Code based workspaces
- Add a .che/che-theia-plugins.yaml or .che/che-editor.yaml to customize it even further
*:
- Choose to deploy Che on a Kubernetes cluster or use Red Hat Developer Sandbox
- Add the GitHub action to the project
- If not using Developer Sandbox, customize the GitHub action to point to the Che instance
Adopting Che has to be at the same heading level as User Onboarding, so the User Guide TOC will look like this:
Adopting Che/CRW
User Onboarding
Advanced Use
- is duplicated by
-
RHDEVDOCS-3822 CRW 3.0 Story #5b UG How a maintainer of a project can setup his project to use Che
- Closed
- is related to
-
RHDEVDOCS-3521 CRW 3.0 Story #2 UG Contributing for the first time to a project
- Closed