-
Notifications
You must be signed in to change notification settings - Fork 26
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
Docs: Plugin E2E - Update docs #858
Conversation
Hello! 👋 This repository uses Auto for releasing packages using PR labels. ✨ This PR can be merged. It will not be considered when calculating future versions of the npm packages and will not appear in the changelogs. |
b0b0eae
to
12f7ba4
Compare
Co-authored-by: Timur Olzhabayev <timur.olzhabayev@grafana.com>
Co-authored-by: Timur Olzhabayev <timur.olzhabayev@grafana.com>
Co-authored-by: Timur Olzhabayev <timur.olzhabayev@grafana.com>
Co-authored-by: Timur Olzhabayev <timur.olzhabayev@grafana.com>
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.
Added some comments, but overall lgtm. I've not tested links or the actual steps (but don't think theres many new instructions if any as part of this)
|
||
## Uninstalling Cypress and @grafana/e2e | ||
|
||
Although we recommend moving from `@grafana/e2e` to `@grafana/plugin-e2e` in a timely manner, there's nothing preventing you from having the two side by side during a transitional phase. |
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.
We could warn here about issues targeting versions greater than 11 using cypress
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 don't think it's necessary. We've already made it clear at the top of the page that the package won't be supported after G11.
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 think theres a difference between not being supported and not working entirely, people might just expect that no new features would be added and fixes not applied. But not a blocker by any sense
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.
Nice work @sunker ! 👏
Nothing blocking here IMHO but caught a few typos.
Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>
Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>
Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>
Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>
Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>
Co-authored-by: David Harris <david.harris@grafana.com>
Changes applied. Thanks for feedback everyone! |
What this PR does / why we need it:
Now that create-plugin will scaffold Playwright and grafana/plugin-e2e instead of Cypress based grafana/e2e, the docs needs to be updated accordingly. This PR does the following changes:
Migrating from grafana/e2e
article. This guide walks through how to manually install Playwright and plugin-e2e, how to migrate tests, setup CI and how to uninstall grafana/e2e.Get started
guide is now focused on plugins that have been scaffolded with plugin-e2e setup. only walks through the steps needed to run the specs that were generated by create plugin.Do not merge before this PR is merged.
Which issue(s) this PR fixes:
Part of https://github.com/grafana/grafana-plugins-platform-team/issues/105
Fixes #
Special notes for your reviewer: