Docs: add data source configuration guide #1118
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. |
| @@ -0,0 +1,135 @@ | |||
| --- | |||
| id: data-source-configuration | |||
| title: Configure data sources | |||
There was a problem hiding this comment.
The current title makes it sound like we are going to teach developers how to configure their data sources instead of how to create good data source configuration options
Should this instead be "Best practices for data source configuration pages" ?
|
|
||
| ## Description and required fields | ||
|
|
||
| We recommend using the `DataSourceDescription` component from the [@grafana/experimental](https://github.com/grafana/grafana-experimental) repository. The plugin name and documentation link are required, but details about other fields is optional. |
There was a problem hiding this comment.
I am against suggesting people from using any kind of component from the grafana-experimental package. It is called experimental because we will break things there without any notice and we can't guarantee this document will keep up to date with changes in that repository.
If we are going to start recommending that component we will have to promote that component to grafana-ui.
@sympatheticmoose thoughts?
|
|
||
| Use the `Authentication` component for handling authentication on the configuration page. This component is already wrapped inside a `ConfigSection`, so additional wrapping is unnecessary. | ||
|
|
||
| If your data source uses the deprecated `DataSourceHttpSettings` component for authentication, replace it with the `Authentication` component. For guidance on migrating from `DataSourceHttpSettings`, see the section below. |
There was a problem hiding this comment.
Is DataSourceHttpSettings really deprecated?
I can't find anywhere where is tagged as deprecated. it is not mention in the source code https://github.com/grafana/grafana/blob/main/packages/grafana-ui/src/components/DataSourceSettings/DataSourceHttpSettings.tsx or in the story page docs https://developers.grafana.com/ui/latest/index.html?path=/docs/data-source-datasourcehttpsettings--docs and furthermore we actually recommend this component as the easiest way to go to configure authentication
| @@ -0,0 +1,135 @@ | |||
| --- | |||
| id: data-source-configuration | |||
There was a problem hiding this comment.
is this a duplicated version of the previous file?
Add guide for data source plugin configuration