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.

Sign up for GitHub

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

Jump to bottom

Docs: Create documentation for enterprise caching HTTP API #67169

Merged
merged 5 commits into from Apr 27, 2023
Merged

Docs: Create documentation for enterprise caching HTTP API #67169

merged 5 commits into from Apr 27, 2023

Conversation

mmandrus
Copy link
Contributor

@mmandrus mmandrus commented Apr 24, 2023 •
edited

What is this feature?

Creates documentation for the query and resource caching HTTP API

Why do we need this feature?

Customer request.

Which issue(s) does this PR fix?:

Fixes https://github.com/grafana/grafana-enterprise/issues/4957

Special notes

Please give an extra look to the metadata section at the top, I may have overdone it with aliases and key words

@mmandrus mmandrus requested a review from Eve832 as a code owner April 24, 2023 23:07
@mmandrus mmandrus added this to the 10.0.0 milestone Apr 24, 2023
@osg-grafana
Copy link
Contributor

@Eve832, as triager this week, I have put this into the team project and into In review.

@chri2547 chri2547 requested a review from josmperez April 25, 2023 11:54
Eve832
Eve832 approved these changes Apr 25, 2023
View reviewed changes
Copy link
Collaborator

@Eve832 Eve832 left a comment •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for adding this!
Just one minor nit and two questions:

  • does this apply to Cloud users or only on-prem?
  • Which version of Grafana does this ship with?

docs/sources/developers/http_api/query_and_resource_caching.md Outdated Show resolved Hide resolved
@mmandrus @Eve832
Update docs/sources/developers/http_api/query_and_resource_caching.md
0ffb563 
Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
@mmandrus
Copy link
Contributor Author

Thank you for adding this! Just one minor nit and two questions:

  • does this apply to Cloud users or only on-prem?
  • Which version of Grafana does this ship with?

@Eve832

  1. this is for both on-prem and cloud. note that I copied from another HTTP API page, so the disclaimers/notes are consistent with what the rest of our docs say
  2. This feature has existed for a long time, it was just never documented. These docs apply to all currently supported versions of Grafana.

@mmandrus mmandrus enabled auto-merge (squash) April 27, 2023 14:28
@mmandrus mmandrus merged commit e9971dd into main Apr 27, 2023
10 checks passed
@mmandrus mmandrus deleted the mmandrus/query-caching-docs branch April 27, 2023 14:28
@zerok zerok modified the milestones: 10.0.0, 10.0.0-preview May 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Eve832 Eve832 Eve832 approved these changes

@josmperez josmperez Awaiting requested review from josmperez

Assignees
No one assigned
Labels
add to changelog no-backport Skip backport of PR type/docs
Projects
None yet
Milestone
10.0.0-preview
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@mmandrus @osg-grafana @Eve832 @zerok