Skip to content
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

Merged
merged 20 commits into from
Apr 5, 2024
Merged

Docs: Plugin E2E - Update docs #858

merged 20 commits into from
Apr 5, 2024

Conversation

sunker
Copy link
Contributor

@sunker sunker commented Apr 4, 2024

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:

  • there's a new 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.
  • the 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.
  • removing all notices about plugin-e2e being in beta
  • adding notice about grafana/e2e being deprecated

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:

Copy link

github-actions bot commented Apr 4, 2024

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.

@sunker sunker force-pushed the sunker/update-plugin-e2e-docs branch from b0b0eae to 12f7ba4 Compare April 4, 2024 15:57
@sunker sunker added the no-changelog Don't include in changelog and version calculations label Apr 4, 2024
@sunker sunker marked this pull request as ready for review April 4, 2024 16:00
@sunker sunker requested a review from a team as a code owner April 4, 2024 16:00
@sunker sunker requested review from leventebalogh and removed request for a team April 4, 2024 16:00
@sunker sunker changed the title Docs: Plugin-E2E - Update docs Docs: Plugin E2E - Update docs Apr 4, 2024
sunker and others added 6 commits April 4, 2024 18:43
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>
@sunker sunker requested a review from josmperez April 4, 2024 16:48
Copy link
Contributor

@sympatheticmoose sympatheticmoose left a 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)

docusaurus/docs/e2e-test-a-plugin/get-started.md Outdated Show resolved Hide resolved
docusaurus/docs/e2e-test-a-plugin/introduction.md Outdated Show resolved Hide resolved

## 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.
Copy link
Contributor

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

Copy link
Contributor Author

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.

Copy link
Contributor

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

Copy link
Collaborator

@jackw jackw left a 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.

docusaurus/docs/e2e-test-a-plugin/introduction.md Outdated Show resolved Hide resolved
docusaurus/docs/e2e-test-a-plugin/get-started.md Outdated Show resolved Hide resolved
docusaurus/docs/e2e-test-a-plugin/get-started.md Outdated Show resolved Hide resolved
sunker and others added 3 commits April 5, 2024 15:30
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>
@sunker
Copy link
Contributor Author

sunker commented Apr 5, 2024

Changes applied. Thanks for feedback everyone!

@sunker sunker merged commit c09e719 into main Apr 5, 2024
12 checks passed
@sunker sunker deleted the sunker/update-plugin-e2e-docs branch April 5, 2024 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Don't include in changelog and version calculations
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

4 participants