Add Global API Changes migration page #125
Conversation
|
Preview is now available at https://deploy-preview-125--vue-next.netlify.app/guide/migration/global-api.html. |
There was a problem hiding this comment.
@phanan great guide! WDYT about adding a section to the top of the doc with the table/short reference of How it was on Vue 2 / how it is in Vue 3, so people who are already familiar with the reasoning behind these changes could simply check the new syntax?
|
You mean this one?
|
|
@phanan yup! WDYT about moving it to the very top, like a table of reference? No strong opinions here, I'm rather thinking out loud |
|
I'm not sure TBH. Right now it kind of has a "flow" with it: We start with a current limitation, then move on to introduce the "fix" ( |
|
@phanan I really like the flow too! My question rather is: will we have a short changelog/reference for those who don't need the explanation? So they could simply check syntax without diving into details? However, this is not a blocking concern so feel free to ignore it 😅 |
|
Hmm, I see your point. However, this also means we'd need to agree on this new format (of having a short leading summary) and apply it to all other migration pages. |
Agreed. Maybe what we need is like a: Quick OverviewHere's the basic run down of the changes... IntroductionAnd now we explain everything in depth |
src/.vuepress/config.js
Outdated
| { | ||
| title: 'Migration to Vue 3', | ||
| collapsable: true, | ||
| children: ['migration'] |
There was a problem hiding this comment.
I'm confused. Why was the old page obsolete? Might need to be broken out, but the introduction is still current if I'm not mistaken.
There was a problem hiding this comment.
"Obsolete" isn't the right word in hindsight—basically I wasn't sure what to be done with it. Open to suggestion/modification!
There was a problem hiding this comment.
No worries! I agree with you that it needs to be updated. Since I don't want your work to be blocked by that update, do you mind if we add it back in as it was and I can break it out into different sections?
|
Great job on this @phanan! Do you plan on adding the Global Treeshaking section to this PR too? Or will that be a separate one? |
|
@bencodezen I plan to add Treeshaking in another PR after this, if everyone's OK with it 😬 |
| { | ||
| title: 'Migration to Vue 3', | ||
| collapsable: true, | ||
| children: ['migration'] | ||
| children: [ | ||
| 'migration/global-api', |
There was a problem hiding this comment.
| 'migration/global-api', | |
| 'migration', | |
| 'migration/global-api', |
There was a problem hiding this comment.
@phanan Other than moving the current migration page back into the sidebar, I'm good to go on my end. Nice work!
|
I'm merging this PR to move to the next (Global API Treeshaking). For the remaining issues, we can revise in beta. |
Note: Although "Global API Changes" and "Global API Treeshaking" are related topics, having both of them on the same page would create a very long page. As a result, I'm still listing them as two separate pages. If you have a better idea, I'm all ears 🙂.
Also, the (obsolete?) Migration page is removed from the sidebar.