Docs: Split fetch data topic in two #1115
Conversation
josmperez
added
type/docs
|
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. |
josmperez
added
no-changelog
| @@ -0,0 +1,132 @@ | |||
| --- | |||
| id: fetch-data-from-frontend-to-app | |||
| title: Fetch data from frontend code to app plugin using the data proxy | |||
There was a problem hiding this comment.
This title is a bit confusing to read for me, it makes it looks like the frontend code and the app plugin are two different things that interact with each other. which though they technically are, it is not what we trying to show here.
There was a problem hiding this comment.
Maybe change it to the following?
| title: Fetch data from frontend code to app plugin using the data proxy | |
| title: Fetch data from frontend code in app plugin using the data proxy |
|
|
||
| This guide explains how the data proxy works in app plugins and explores common issues in its usage. For usage related to data source plugins, refer to our [documentation](../data-source-plugins/fetch-data-from-frontend.md) | ||
|
|
||
| ## How does it work? |
There was a problem hiding this comment.
I noted that most or all of the content here until the specific app example is a copy of the other article. could you instead create a shared file and use it here? that way we don't have to maintain two different articles with the same content.
| @@ -0,0 +1,132 @@ | |||
| --- | |||
| id: fetch-data-from-frontend-to-app | |||
| title: Fetch data from frontend code to app plugin using the data proxy | |||
There was a problem hiding this comment.
Maybe change it to the following?
| title: Fetch data from frontend code to app plugin using the data proxy | |
| title: Fetch data from frontend code in app plugin using the data proxy |
|
|
||
| - for overcoming cross-site (CORS) limitations, or | ||
| - for performing authenticated requests, or | ||
| - for sending other sensitive data from your plugin configuration to Grafana. |
There was a problem hiding this comment.
It could also be to external services/resources. E.g. if your plugin configure an authentication token that you need to use to interact with a third party API. Then you can use the data proxy to append that token before sending the request to the third party API without leaking the token to the frontend.
| @@ -1,7 +1,7 @@ | |||
| --- | |||
| id: fetch-data-from-frontend | |||
| title: Fetch data from frontend code using the data proxy | |||
| description: Learn how to use the data proxy API to fetch data from frontend code in data source and app plugins in Grafana | |||
| title: Fetch data from frontend code to data source plugin using the data proxy | |||
There was a problem hiding this comment.
| title: Fetch data from frontend code to data source plugin using the data proxy | |
| title: Fetch data from frontend code in a data source plugin using the data proxy |
Split fetch data with data proxy into two: data source plugins and app plugins.
Fixes: #977