docs(migrating): restructure migrating section for further consolidation#10451
docs(migrating): restructure migrating section for further consolidation#10451BlueCutOfficial wants to merge 1 commit intowarp-drive-data:mainfrom
Conversation
This is going to really depend on the app. My impression is that most of the apps that haven't made the jump from 4.x to 5.x haven't done so because they are stuck due to deprecations such as those for array-like and promise-proxies or are using model fragments. Any app stuck due to deprecations is going to have an easier time migrating using the two-store approach, while any app that already made the jump can just intermix models and schemas during the migration. When the two-store approach doc was originally written, it was just one of several distinct migration paths possible: the point being to provide app's flexibility in how to migrate depending on their specific circumstances - what we need to do better is describe when each approach is best. |
|
The point you are making is 100% compatible with the changes I am suggesting for the Migrating doc IMO.
Right, but this migration is not explicitly documented in the Migrating guide. Developers have to make their way with all the existing guides (setup, manual sections, legacy-mode-related content...), without being confused by a migrating guide that is called "migrating" but actually doesn't match their migration scenario. I first tried to move from EmberData to WarpDrive with a 6.9 app building with Vite, and it was not easy for me to figure out the right path.
I totally agree with this 👍 and I think a good place for this is the migrating/index.md that I introduce in this PR. I designed this PR as a first iteration that simply moves the information to leave room for more improvements for the Migrating guides. I didn't want to write new content in this PR to keep the structure concern and the content concern separate, and keep each piece reviewable and mergeable; but I am happy to draft the next steps I imagine for the guides if that can make this one clearer, or at least make the bullet points in the introduction a bit more explicit. |
b28b89d to
fd0b4dd
Compare
This PR proposes restructuring the information on migrating from Model to Schema, to make it easier to find and potentially open up more migration paths.
Motivation:
@warp-drive/legacy, it is now possible to have models and schemas coexisting using only one legacy store. The mirror approach seems overly complicated to enable having schemas in the simpler scenarios. The migrating guide should probably provide this more straightforward migration path.1st Iteration Suggestion:
This structure lays the groundwork for more iterations on the migrating section: we could more easily add a new doc for a migration path that simply changes the existing store to be a WarpDrive legacy store, extract shared prerequisites from the existing 2-store-based cookbook to simplify it (and potentially re-merge it with the concept doc and avoid a sub-section), etc.