Skip to content

Updates to migration content #3766

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

Merged
merged 4 commits into from
Mar 31, 2021
Merged

Conversation

jennifer-shehane
Copy link
Member

@jennifer-shehane jennifer-shehane commented Mar 31, 2021

  1. At the beginning, it's stated that there are 5 steps for migrating. Then there are many many more sections within and after outlining these 5 steps that make the process of migration confusing.

The steps outlined were:

  1. Update your configuration file, cypress.json by default, to remove experimentalComponentTesting
  2. Install updated dependencies
  3. Update the plugins file
  4. Use CLI commands to launch
  5. Update the support file (optionally)

But then there are more sections for Expanded stylesheet support (within the steps), Desktop GUI no longer displays component tests, Executing all or some component tests, Coverage, etc etc etc.

We need to be very clear about the steps required to take for migration. People do not want to spend their time reading about implementation details or niceties of the new component testing. They need migration to be clear and as quick as possible so things won't break.

This is extra important considering all of the other breaking changes along with it. I would recommend

  • Cut down the content to the bare necessary and when possible refer to the component testing docs for extra detail (like the cypress.json overrides and testingType - this is already documented elsewhere and is not a breaking change needed for migration).
  • Do not explain implementation details on 'why' a change was made. Simply state the action they need to take to get their code working.

  1. The Component Testing needs to be a single section within the 7.0 Migration - there are several sections within 7.0 that people need to be aware of altogether.

Screen Shot 2021-03-31 at 9 42 35 AM

New hierarchy

Screen Shot 2021-03-31 at 9 44 36 AM

@JessicaSachs JessicaSachs merged commit 8277776 into ct-7-migration Mar 31, 2021
@matthamil matthamil deleted the more-migration-suggestions branch April 14, 2021 19:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants