Docs: Plugin E2E - Using the api article #885
Conversation
sunker
added
the
no-changelog
|
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. |
| If you chose to add a Github workflow when you scaffolded the plugin, the Playwright end-to-end tests will be run in CI targeting the most recent version of Grafana. To take full advantage of plugin-e2e, it's recommended to follow the instructions in the [CI](./ci.md) guide to run Playwright end-to-end tests targeting all versions of Grafana that your plugin supports. | ||
| The [`grafanaDependency`](../metadata.md#properties-1) property in the plugin.json file dictates what versions of Grafana the plugin is compatible with. It's recommended to run your Playwright end-to-end tests targeting all the supported versions. The Github workflow that was included when scaffolding the plugin ensures this is the case. | ||
|
|
||
| If you chose to not add a Github workflow when you scaffolded the plugin, it's recommended to follow the instructions in the [CI](./ci.md) guide to run Playwright end-to-end tests targeting all versions of Grafana that your plugin supports. | ||
|
|
There was a problem hiding this comment.
Even though unrelated to the new API article, I'm taking the chance to update this section as it was outdated.
| @@ -80,53 +80,6 @@ export type PluginFixture = { | |||
| */ | |||
| selectors: E2ESelectors; | |||
|
|
|||
| /** | |||
There was a problem hiding this comment.
changing the order of the fixtures in the public api so that all pages are next to each other.
This breaks the Grafana documentation recommended structure (how-to articles almost always start with verbs in the title); however, if you prefer the nouns, I do not object because I don't think this harms usability. Doc guidelines aren't iron clad rules. |
Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com>
Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com>
Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com>
Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com>
Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com>
Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com>
Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com>
| @@ -1,6 +1,6 @@ | |||
| --- | |||
| id: use-authentication | |||
| title: Use authentication | |||
| title: Authentication | |||
There was a problem hiding this comment.
non-blocking but I don't see the removal of Use as making this more in keeping with the other elements. Select, Configure, Test, etc etc
Co-authored-by: David Harris <david.harris@grafana.com>
What this PR does / why we need it:
This article is giving a high level intro on how to use the plugin-e2e api, and the page fixtures in particular.
Also removing the
Useprefix from the title in the auth article and in the feature toggle article so they follow the same naming convention as all the other e2e articles.Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer: