Improve the Che 6 -> Che 7 migration doc
See original GitHub issueIs your task related to a problem? Please describe.
I tried to migrate Che 6 workspace to Che 7 using this documentation: https://www.eclipse.org/che/docs/che-7/converting-a-che-6-workspace-to-a-che-7-devfile/ and I have a few issues.
The first problem is accessing a documentation. There is already issue for that https://github.com/eclipse/che/issues/14308
The procedure of migration Che 6 workspace to Che 7: 1. Open an old Che 6 configuration file. There are steps how to access configuration file, but those steps are placed at the end of a document. I think it would be more useful to have them right in this step. I didn’t expect those steps to be at the end so I found them when I was done.
2. Create a new workspace from the similar Che 7 devfile
There are not all old stack types listed in a Table 1
, e.g. vert.x is missing.
3. Add the required number of blank projects.
I’m not sure if I was supposed to create a workspace first and then go to the Workspace configuration to the Projects
window to add a blank project or add a blank project before I create a workspace. If the second option is correct, this step should be a part of a second step.
Anyway, I was not able to find out how to add blank project trying both ways:
-
adding project to already created workspace
-
adding project when creating a workspace
4. Change the required devfile fields. I don’t understand what a screenshot at this section is trying to say me:
There is no info where to find a devfile fields. I think it would be useful to have there some example on how to change a devfile or even a link to a devfile specification, so user can see what are the parameters he/she can set up.
Describe the solution you’d like
Update obsolete information - user is not able to create blank project anymore. Replace that with the guide how can then import a project, which is used in Che 6 workspace (e.g. change a devfile, import project when creating Che 7 worksapce, import project from Theia UI). Make the documentation clearer even for users who are not much familiar with devfile or does not have much experiences with a Dashboard e.g. by including some screenshots or more precise steps.
Issue Analytics
- State:
- Created 4 years ago
- Reactions:5
- Comments:9 (8 by maintainers)
Top GitHub Comments
@ibuziuk I can try 😄 I’m not good at writing docs, so I will write some “draft” and ask you for a review then 😃
The PR with changes in migration docs was merged and documentation is currently up-to-date. I’ll close this issue. @olexii4 If you find some areas that are not described enough or you want to enhance the docs, please feel free to create another PR to https://github.com/eclipse/che-docs. Thank you!