Update user storage documentation #2404
Conversation
Removed notes about the userStorageAPI feature flag and fallback to localStorage.
github-project-automation
bot
moved this to 📬 Triage
in Plugins Platform / Grafana Community
|
|
grafana-plugins-platform-bot
bot
moved this from 📬 Triage
to 🔬 In review
in Plugins Platform / Grafana Community
There was a problem hiding this comment.
Pull request overview
This PR updates the user storage documentation by removing references to the userStorageAPI feature flag and the localStorage fallback mechanism, indicating that the user storage feature is now generally available in Grafana 11.5+ without requiring feature flag enablement.
Changes:
- Removed two bullet points from the important admonition block about feature flag requirements and localStorage fallback behavior
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Clarified user storage feature availability and fallback mechanism.
Co-authored-by: Anna Urbiztondo <anna.urbiztondo@grafana.com>
urbiz-grafana
left a comment
urbiz-grafana
left a comment
There was a problem hiding this comment.
LGTM, minor suggestions.
Co-authored-by: Anna Urbiztondo <anna.urbiztondo@grafana.com>
|
|
||
| - This feature is available in Grafana 11.5 and later under the `userStorageAPI` feature flag. If a plugin uses this feature but it's not enabled in the Grafana instance, the browser `localStorage` will be used as the storage mechanism instead. | ||
| - This feature is GA in Grafana 12.0 and after. | ||
| - This feature is GA in Grafana 12.0 and later. |
There was a problem hiding this comment.
Could also link to https://grafana.com/docs/release-life-cycle/.
There was a problem hiding this comment.
Nit: I'd swap the paragraphs so people on 12.0+ doesn't have to keep reading. Maybe rephrasing things a bit:
This feature is available in Grafana 12.0 and later. From Grafana >11.5 and <12.0, the feature is behind a feature flag
userStorageAPI. If a plugin uses this feature but it's not enabled in the Grafana instance, the browser'slocalStoragewill be used as the storage mechanism instead.
4 participants
Removed notes about the userStorageAPI feature flag and fallback to localStorage.
What this PR does / why we need it:
This PR updates the doc, since this feature is now GA and not anymore behind a feature flag.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer: