Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs: improve migration from v2 guide #8417

Merged
merged 4 commits into from
May 31, 2022

Conversation

sapphi-red
Copy link
Member

@sapphi-red sapphi-red commented May 31, 2022

Description

I checked the commit log from 2.9.8 and added descriptions for breaking changes which was missing.

There are potentially breaking changes which I didn't include.

And some which only affects plugin/tool creators which I didn't include.

Also I didn't include breaking changes of plugins.

Additional context


What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines and follow the Commit Convention.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.

@sapphi-red sapphi-red added the documentation Improvements or additions to documentation label May 31, 2022
@patak-dev patak-dev merged commit f2c869d into vitejs:main May 31, 2022
@patak-dev
Copy link
Member

Thanks for the PR @sapphi-red 💚

About the ones you list in the description, I think it would be useful to have them in the migration guide in a new Advanced section. Maybe we could directly list the PR as you did here with a line each instead of a detailed explanation. And users can check the complete rationale and context in the PRs. What do you think?

@sapphi-red
Copy link
Member Author

I think it would be useful. I'll create another PR for that! 👍

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants