-
Notifications
You must be signed in to change notification settings - Fork 11.7k
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 migration guide 7.0.0 to 8.0.0 #38911
Conversation
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
Co-authored-by: Will Browne <wbrowne@users.noreply.github.com>
Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.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 more review.
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.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.
Looks good. We can fix doc issues we may have missed in a future PR.
* restructuring to new storybook inspired structure. * added instructions on how to handle breaking changes in the legend. * start adding migration steps for 7 -> 8 * added information about the data frame format changes. * added plugin.json changes. * added emotion 11 imports. * added information about theme v1 being deprecated. * added steps for backend plugin migration. * added reference to the migrate hooks v6 -> v7. * docs(pluginmigration): introduce getColorForTheme changes * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com> * docs(migration-guide): introduce useStyles to v8 deprecation notes * Apply suggestions from code review Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * suggestion from review. * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * docs(Migration Guide): update the example for `grafanaDependency` * docs(Migration Guide): remove the time-series migration part for now * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Will Browne <wbrowne@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> * docs(Migration Guide): update wording about plugin signing * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com> Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com> Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> Co-authored-by: Will Browne <wbrowne@users.noreply.github.com> Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> (cherry picked from commit aba8af1)
* restructuring to new storybook inspired structure. * added instructions on how to handle breaking changes in the legend. * start adding migration steps for 7 -> 8 * added information about the data frame format changes. * added plugin.json changes. * added emotion 11 imports. * added information about theme v1 being deprecated. * added steps for backend plugin migration. * added reference to the migrate hooks v6 -> v7. * docs(pluginmigration): introduce getColorForTheme changes * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com> * docs(migration-guide): introduce useStyles to v8 deprecation notes * Apply suggestions from code review Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * suggestion from review. * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * docs(Migration Guide): update the example for `grafanaDependency` * docs(Migration Guide): remove the time-series migration part for now * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Will Browne <wbrowne@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> * docs(Migration Guide): update wording about plugin signing * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com> Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com> Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> Co-authored-by: Will Browne <wbrowne@users.noreply.github.com> Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> (cherry picked from commit aba8af1)
The backport to
To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-38911-to-v8.0.x origin/v8.0.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x aba8af1d599ae4f67f9ffc92044eb477ca36455d
# Push it to GitHub
git push --set-upstream origin backport-38911-to-v8.0.x
git switch main
# Remove the local backport branch
git branch -D backport-38911-to-v8.0.x Then, create a pull request where the |
The backport to
To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-38911-to-v8.1.x origin/v8.1.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x aba8af1d599ae4f67f9ffc92044eb477ca36455d
# Push it to GitHub
git push --set-upstream origin backport-38911-to-v8.1.x
git switch main
# Remove the local backport branch
git branch -D backport-38911-to-v8.1.x Then, create a pull request where the |
* restructuring to new storybook inspired structure. * added instructions on how to handle breaking changes in the legend. * start adding migration steps for 7 -> 8 * added information about the data frame format changes. * added plugin.json changes. * added emotion 11 imports. * added information about theme v1 being deprecated. * added steps for backend plugin migration. * added reference to the migrate hooks v6 -> v7. * docs(pluginmigration): introduce getColorForTheme changes * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com> * docs(migration-guide): introduce useStyles to v8 deprecation notes * Apply suggestions from code review Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * suggestion from review. * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * docs(Migration Guide): update the example for `grafanaDependency` * docs(Migration Guide): remove the time-series migration part for now * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Will Browne <wbrowne@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> * docs(Migration Guide): update wording about plugin signing * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com> Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com> Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> Co-authored-by: Will Browne <wbrowne@users.noreply.github.com> Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> (cherry picked from commit aba8af1) Co-authored-by: Marcus Andersson <marcus.andersson@grafana.com>
* restructuring to new storybook inspired structure. * added instructions on how to handle breaking changes in the legend. * start adding migration steps for 7 -> 8 * added information about the data frame format changes. * added plugin.json changes. * added emotion 11 imports. * added information about theme v1 being deprecated. * added steps for backend plugin migration. * added reference to the migrate hooks v6 -> v7. * docs(pluginmigration): introduce getColorForTheme changes * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com> * docs(migration-guide): introduce useStyles to v8 deprecation notes * Apply suggestions from code review Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * suggestion from review. * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * docs(Migration Guide): update the example for `grafanaDependency` * docs(Migration Guide): remove the time-series migration part for now * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Will Browne <wbrowne@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> * docs(Migration Guide): update wording about plugin signing * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/developers/plugins/migration-guide.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com> Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com> Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> Co-authored-by: Will Browne <wbrowne@users.noreply.github.com> Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> (cherry picked from commit aba8af1) Co-authored-by: Marcus Andersson <marcus.andersson@grafana.com>
…-github to revdev * commit '56aebaac32bd7a82f84a571969b51c62ba54fd6d': (23 commits) "Release: Updated versions in package to 8.1.4" (grafana#39273) Docs: Update azuread docs to mention about env variables (grafana#39203) (grafana#39265) Docs: plugin migration guide 7.0.0 to 8.0.0 (grafana#38911) (grafana#39246) Docs: Added "manageAlerts" provisioning option. (grafana#38836) (grafana#39253) BarChart: Fix legend and tooltip colors off by 1 after data refresh (grafana#39234) (grafana#39252) Update silences.md (grafana#38834) (grafana#39243) Explore: Ensure logs volume bar colors match legend colors (grafana#39072) (grafana#39120) Graph: make old graph panel thresholds work even if ngalert is enabled (grafana#38918) (grafana#39233) Fix regex to identify / as separator (grafana#39220) [v8.1.x] BarChart: fix stale bar values and x axis labels Add link to default template (grafana#39106) (grafana#39138) Doc: Created a separate topic for AWS authentication (grafana#39012) (grafana#39160) LDAP: Search all DNs for users (grafana#38891) (grafana#39167) Docs: Fix broken link to signed GCS URLs docs (grafana#39144) (grafana#39149) [v8.1.x] Variables: Fix not updating inside a Panel when the preceding Row uses "Repeat For" (grafana#39141) Docs: Improve v8 upgrade notes for SQL data sources (grafana#38792) (grafana#39124) Explore: Trace view now shows trace start time in selected timezone (grafana#39054) (grafana#39093) Alerting: Fix notification channel migration (grafana#38983) (grafana#39053) Annotations: Fixes blank panels for queries with unknown data sources (grafana#39017) (grafana#39034) Copy cue.mod and packages/grafana-schema to container workdir (grafana#38998) (grafana#39018) ...
What this PR does / why we need it:
This PR will restructure the migration guide to be structured more like the Storybook migration guide is structured.
It will also add migration steps for how to migrate a plugin from 7.x.x to 8.x.x
Which issue(s) this PR fixes:
Fixes #38911
Special notes for your reviewer:
If I have missed anything or describing anything in an incorrect way feel free to jump in and make changes.