-
Notifications
You must be signed in to change notification settings - Fork 810
Document Deploy legacy property type migrators, import and migration flow and clarify grid editor configuration #6533
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
Document Deploy legacy property type migrators, import and migration flow and clarify grid editor configuration #6533
Conversation
sofietoft
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added some suggestions and comments.
The same suggestions applies to version 14 🙌
| ### Import and migration flow | ||
|
|
||
| When an import is started, the following happens: | ||
| 1. Artifact signatures are read from the import provider (using `IArtifactImportProvider.GetArtifactSignatures()`). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Before I start working on this list, I need to know: Is it steps that the user needs to go through, or is it an explanation of what happens during a migration/import? 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is an explanation of the things that happen and should give users a better understanding of the (order of) operations.
We also hadn't documented the notifications yet or the fact a default ValidateArtifactImportDependenciesNotificationHandler is added by Deploy. We might want to add a separate section about notifications though, as we also have notifications that happen during export (ArtifactExportingNotification and ArtifactExportedNotification).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks. I wont touch the list then 💪
It would be great to have a new section about notifications.
Let me know what you need from us to set this up!
13/umbraco-deploy/deployment-workflow/import-with-migrations.md
Outdated
Show resolved
Hide resolved
13/umbraco-deploy/deployment-workflow/import-with-migrations.md
Outdated
Show resolved
Hide resolved
13/umbraco-deploy/deployment-workflow/import-with-migrations.md
Outdated
Show resolved
Hide resolved
Co-authored-by: sofietoft <stk@umbraco.com>
Description
Deploy Contrib 13.3 and 14.2 added legacy property type migrators (besides the artifact migrators, see PR umbraco/Umbraco.Deploy.Contrib#71), which requires extra setup code to correctly migrate all values from version 7. I've currently only amended the documented composer with the required code and an inline comment, as I don't think we need to add a separate mention about this...
While preparing my talk for DF24, I also noticed we currently don't have any documentation about the import and migration flow, including the notifications that are published. I've added a new paragraph/section to list out all steps involved in this operation.
Finally, I've added notes about providing custom grid editor configurations when migrating the legacy Grid editor to the Block Grid editor, resolving umbraco/Umbraco.Deploy.Issues#236.
Type of suggestion
Product & version (if relevant)
Deploy 13 & 14
Deploy Contrib 13.3 and 14.2
Deadline (if relevant)
This applies to already released Deploy and Deploy Contrib versions, so can be merged ASAP.