Update migration guide. #22

yhontyk · 2020-11-18T10:55:14Z

Added description of v2 changes w/ links to respective issues and some language suggestions.

yhontyk · 2020-11-18T10:57:09Z

@elsony could you PTAL if everything is correct content-wise?
@jc-berger could you please provide a language review? ☺️

Thanks.

elsony · 2020-11-18T22:34:40Z

docs/modules/ROOT/pages/migration_guide.adoc


-=== starterProjects and projects description
+=== `starterProjects` and projects description


Is there any reason we have a different format for starterProjects vs projects given that both are elements within the devfile? If one is with ` then the other should also have it.

Good catch! Added backticks around project.

elsony · 2020-11-18T22:36:45Z

docs/modules/ROOT/pages/migration_guide.adoc

@@ -75,35 +75,35 @@ components:

 Details can be found in the https://github.com/che-incubator/devworkspace-api/issues/4[corresponding issue].


Change this URL to devfile/api#4

elsony · 2020-11-18T22:37:26Z

docs/modules/ROOT/pages/migration_guide.adoc

@@ -75,35 +75,35 @@ components:

 Details can be found in the https://github.com/che-incubator/devworkspace-api/issues/4[corresponding issue].

-=== Shared Volumes Across Components
+=== Shared volumes across components

 Details can be found in the https://github.com/che-incubator/devworkspace-api/issues/19[corresponding issue].


Change this URL to devfile/api#19

elsony · 2020-11-18T22:40:59Z

docs/modules/ROOT/pages/migration_guide.adoc


 Details can be found in the  https://github.com/devfile/api/issues/48[corresponding issue].

-=== Replace Alias with Name
+=== Replace alias with Name

 Details can be found in the  https://github.com/che-incubator/devworkspace-api/issues/9[corresponding issue].


Change URL to devfile/api#9
This comment applies to all other URLs that start with
https://github.com/che-incubator/devworkspace-api/issues
and the prefix should be changed to use the prefix
https://github.com/devfile/api/issues

elsony · 2020-11-18T22:41:18Z

docs/modules/ROOT/pages/migration_guide.adoc


 Details can be found in the  https://github.com/che-incubator/devworkspace-api/issues/9[corresponding issue].

-=== Renaming dockerimage component type
+=== Renaming `dockerimage` component type

 Details can be found in the  https://github.com/che-incubator/devworkspace-api/issues/8[corresponding issue].


Change URL prefix, see above.

elsony · 2020-11-18T23:32:19Z

docs/modules/ROOT/pages/migration_guide.adoc

@@ -175,27 +175,27 @@ components:

 Details can be found in the https://github.com/che-incubator/devworkspace-api/issues/31[corresponding issue].


Change URL prefix, see above.

elsony · 2020-11-18T23:32:32Z

docs/modules/ROOT/pages/migration_guide.adoc


 Details can be found in the https://github.com/devfile/api/issues/56[corresponding issue].

-=== Environment Varibables for a Specific Command
+=== Environment variables for a specific command

 Details can be found in the https://github.com/che-incubator/devworkspace-api/issues/21[corresponding issue].


Change URL prefix, see above.

elsony · 2020-11-18T23:32:38Z

docs/modules/ROOT/pages/migration_guide.adoc


 Details can be found in the https://github.com/che-incubator/devworkspace-api/issues/21[corresponding issue].

-=== Renaming workdir into workingDir
+=== Renaming `workdir` into `workingDir`

 Details can be found in the https://github.com/che-incubator/devworkspace-api/issues/22[corresponding issue].


Change URL prefix, see above.

elsony · 2020-11-18T23:32:43Z

docs/modules/ROOT/pages/migration_guide.adoc


 Details can be found in the https://github.com/che-incubator/devworkspace-api/issues/22[corresponding issue].

-=== Id and label for Composite Commands
+=== `Id` and `label` for composite commands

 Details can be found in the https://github.com/che-incubator/devworkspace-api/issues/18[corresponding issue].


Change URL prefix, see above.

elsony · 2020-11-18T23:33:57Z

docs/modules/ROOT/pages/migration_guide.adoc

+----
+v2.0
+---
+  - id: helloWorld


This should be name instead of id

yhontyk · 2020-11-23T12:48:43Z

@elsony Thank you for the review! I've changed the URLs and addressed your other feedback. PTAL when you have time.

elsony

lgtm

rkratky

@boczkowska, adding a bunch of nitpicks.

docs/modules/ROOT/pages/migration_guide.adoc

rkratky · 2020-11-23T16:47:25Z

docs/modules/ROOT/pages/migration_guide.adoc

@@ -73,37 +72,37 @@ components:
       reference: https://.../mongo.yaml
 ----

-Details can be found in the https://github.com/che-incubator/devworkspace-api/issues/4[corresponding issue].
+Details can be found in the https://github.com/devfile/api/issues/4[corresponding issue].


All of the "Details can be found in the >corresponding issue<." sentences would look better with:

No passive tense

Title of the linked issue

E.g.: "For more details, see >Polymorphic component type UX in a devfile<."

docs/modules/ROOT/pages/migration_guide.adoc

rkratky · 2020-11-23T16:55:43Z

docs/modules/ROOT/pages/migration_guide.adoc

@@ -1,9 +1,9 @@
-= Devfile v2 Migration Guide
+= Migrating from devfile v1 to devfile v2


Unless there's a specific reason not to, I believe the use of v1 vs v1.0 and v2 vs v2.0 should be unified.

docs/modules/ROOT/pages/migration_guide.adoc

Co-authored-by: Robert Krátký <rkratky@redhat.com> Co-authored-by: Robert Krátký <rkratky@redhat.com>

yhontyk · 2020-11-24T15:14:29Z

@rkratky thanks! PTAL

rkratky

Thanks, @boczkowska.

openshift-ci-robot · 2020-11-26T15:34:20Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: boczkowska, elsony, rkratky
To complete the pull request process, please assign after the PR has been reviewed.
You can assign the PR to them by writing /assign in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Update migration guide.

ec325ea

elsony requested changes Nov 18, 2020

View reviewed changes

openshift-ci-robot assigned elsony Nov 18, 2020

elsony approved these changes Nov 23, 2020

View reviewed changes

openshift-ci-robot added the lgtm label Nov 23, 2020

rkratky requested changes Nov 23, 2020

View reviewed changes

openshift-ci-robot assigned rkratky Nov 23, 2020

openshift-ci-robot removed the lgtm label Nov 23, 2020

Feedback.

4a6d4ff

Co-authored-by: Robert Krátký <rkratky@redhat.com> Co-authored-by: Robert Krátký <rkratky@redhat.com>

rkratky approved these changes Nov 26, 2020

View reviewed changes

openshift-ci-robot added the lgtm label Nov 26, 2020

rkratky merged commit 7a7a0df into devfile:master Nov 26, 2020

This was referenced Nov 26, 2020

Update migration guide with the latest spec devfile/api#160

Closed

Review Migration Guide for language and consistency devfile/api#182

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update migration guide. #22

Update migration guide. #22

yhontyk commented Nov 18, 2020

yhontyk commented Nov 18, 2020

elsony Nov 18, 2020

yhontyk Nov 23, 2020

elsony Nov 18, 2020

elsony Nov 18, 2020

elsony Nov 18, 2020

elsony Nov 18, 2020

elsony Nov 18, 2020

elsony Nov 18, 2020

elsony Nov 18, 2020

elsony Nov 18, 2020

elsony Nov 18, 2020

yhontyk commented Nov 23, 2020

elsony left a comment

rkratky left a comment

rkratky Nov 23, 2020

rkratky Nov 23, 2020

yhontyk commented Nov 24, 2020

rkratky left a comment

openshift-ci-robot commented Nov 26, 2020


		=== starterProjects and projects description
		=== `starterProjects` and projects description

		@@ -75,35 +75,35 @@ components:

		Details can be found in the https://github.com/che-incubator/devworkspace-api/issues/4[corresponding issue].

		@@ -175,27 +175,27 @@ components:

		Details can be found in the https://github.com/che-incubator/devworkspace-api/issues/31[corresponding issue].

		@@ -1,9 +1,9 @@
		= Devfile v2 Migration Guide
		= Migrating from devfile v1 to devfile v2

Update migration guide. #22

Update migration guide. #22

Conversation

yhontyk commented Nov 18, 2020

yhontyk commented Nov 18, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yhontyk commented Nov 23, 2020

elsony left a comment

Choose a reason for hiding this comment

rkratky left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yhontyk commented Nov 24, 2020

rkratky left a comment

Choose a reason for hiding this comment

openshift-ci-robot commented Nov 26, 2020