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.

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

feat(tag): add query help documentation #23

Merged
merged 2 commits into from
Aug 22, 2023
Merged

feat(tag): add query help documentation #23

merged 2 commits into from
Aug 22, 2023

Conversation

mure
Copy link
Collaborator

@mure mure commented Aug 21, 2023

Pull Request

🀨 Rationale

https://dev.azure.com/ni/DevCentral/_workitems/edit/2485887

πŸ‘©β€πŸ’» Implementation

Data sources can include a query_help.md markdown file to be displayed in the UI. Unfortunately, the webpack configuration extended from the plugin tools doesn't copy that file in to the dist, so I had to manually change the config. I upstreamed a change here: grafana/plugin-tools#374

πŸ§ͺ Testing

  • Built the plugins and viewed the rendered markdown

βœ… Checklist

@mure
Copy link
Collaborator Author

mure commented Aug 21, 2023

Here's how the markdown is rendered in the UI. You click the question mark next to the data source dropdown.

image

@MelissaHilliard

src/datasources/tag/query_help.md Outdated Show resolved Hide resolved
src/datasources/tag/query_help.md Outdated Show resolved Hide resolved
src/datasources/tag/query_help.md Outdated Show resolved Hide resolved
src/datasources/tag/query_help.md Outdated Show resolved Hide resolved
src/datasources/tag/query_help.md Outdated Show resolved Hide resolved
src/datasources/tag/query_help.md Outdated Show resolved Hide resolved
src/datasources/tag/query_help.md Outdated Show resolved Hide resolved
src/datasources/tag/query_help.md Outdated Show resolved Hide resolved
src/datasources/tag/query_help.md Outdated Show resolved Hide resolved
src/datasources/tag/query_help.md Outdated Show resolved Hide resolved
@mure mure merged commit f8ff3d2 into main Aug 22, 2023
1 check passed
@mure mure deleted the tag-query-help branch August 22, 2023 17:14
mure pushed a commit that referenced this pull request Aug 22, 2023
# [2.1.0](v2.0.0...v2.1.0) (2023-08-22)

### Features

* **tag:** add query help documentation ([#23](#23)) ([f8ff3d2](f8ff3d2))
@mure
Copy link
Collaborator Author

mure commented Aug 22, 2023

πŸŽ‰ This PR is included in version 2.1.0 πŸŽ‰

The release is available on:

Your semantic-release bot πŸ“¦πŸš€

@mure mure added the released label Aug 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants