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: Improve Configuration page #404

Closed
4 tasks
andresmgot opened this issue Jun 10, 2022 · 5 comments
Closed
4 tasks

Docs: Improve Configuration page #404

andresmgot opened this issue Jun 10, 2022 · 5 comments
Labels
datasource/ADX effort/none enhancement New feature or request type/docs Issues with or additions to technical documentation

Comments

@andresmgot
Copy link
Contributor

What happened:

While going through ADX functionality, I found several things we can improve for the configuration page:

  • Document settings
  • Test uncovered settings
  • Update tooltips. Some of them are not relevant or with wrong format.
  • Remove toggle for default editor. It's not really useful and adds unnecessary clutter.

Environment:

  • Grafana version:
  • Plugin version: 4.1.0
  • OS Grafana is installed on:
  • User OS & Browser:
  • Others:
@andresmgot andresmgot added enhancement New feature or request datasource/ADX type/docs Issues with or additions to technical documentation labels Jun 10, 2022
@osg-grafana osg-grafana changed the title Configuration page: Small improvements Docs: Improve Configuration page Dec 12, 2022
@GrafanaWriter
Copy link

Hi @andresmgot - Can you let me know which page of documentation you were viewing so we can properly address this issue?

@andresmgot
Copy link
Contributor Author

Hi @GrafanaWriter, it's the plugin README:

https://github.com/grafana/azure-data-explorer-datasource#configuring-grafana

The only part documented are the "Connection Details" but it's also needed to document the rest of sections:

image

@GrafanaWriter
Copy link

We are blocked on fixing this issue until we can free up resources.

@aangelisc
Copy link
Contributor

Closing as OOD and the documentation has been updated since.

@bossinc
Copy link
Contributor

bossinc commented Mar 22, 2024

Will be fully addressed with https://github.com/grafana/oss-plugin-partnerships/issues/757

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
datasource/ADX effort/none enhancement New feature or request type/docs Issues with or additions to technical documentation
Projects
Partner Datasources
Status: Done
Milestone
No milestone
Development

No branches or pull requests
4 participants
@andresmgot @bossinc @aangelisc @GrafanaWriter