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

AdhocFilters: Add docs for AdhocFilterSet and AdhocFiltersVariable #377

Merged
merged 24 commits into from
Oct 3, 2023

Conversation

torkelo
Copy link
Member

@torkelo torkelo commented Sep 29, 2023

Docs!

@torkelo torkelo added the minor Increment the minor version when merged label Sep 29, 2023
Copy link
Contributor

@imatwawana imatwawana left a comment

Choose a reason for hiding this comment

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

Did some wording and grammar edits. Mostly just removing passive voice.

docusaurus/docs/advanced-adhoc-fIlters.md Outdated Show resolved Hide resolved
docusaurus/docs/advanced-adhoc-fIlters.md Outdated Show resolved Hide resolved
docusaurus/docs/advanced-adhoc-fIlters.md Outdated Show resolved Hide resolved
docusaurus/docs/advanced-adhoc-fIlters.md Outdated Show resolved Hide resolved
docusaurus/docs/advanced-adhoc-fIlters.md Outdated Show resolved Hide resolved
docusaurus/docs/advanced-adhoc-fIlters.md Outdated Show resolved Hide resolved
docusaurus/docs/advanced-adhoc-fIlters.md Outdated Show resolved Hide resolved
docusaurus/docs/advanced-adhoc-fIlters.md Outdated Show resolved Hide resolved
docusaurus/docs/advanced-adhoc-fIlters.md Outdated Show resolved Hide resolved
docusaurus/docs/advanced-adhoc-fIlters.tsx Outdated Show resolved Hide resolved
@torkelo torkelo requested a review from imatwawana October 2, 2023 17:28
Comment on lines +24 to +26
// You don't need to set baseFilters, but they're useful if you want to limit label suggestions to only those you deem relevant for the scene.
// These are not shown in the UI.
baseFilters: [{ key: '__name__', operator: '=', value: 'ALERTS', condition: '' }],
Copy link
Member

Choose a reason for hiding this comment

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

An example would be useful for this property

Copy link
Member Author

Choose a reason for hiding this comment

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

@dprokop the code your commenting on is the example (a very useful example of limiting keys to those of a specific metrics name)

docusaurus/docs/advanced-adhoc-fIlters.md Outdated Show resolved Hide resolved
docusaurus/docs/advanced-adhoc-fIlters.md Outdated Show resolved Hide resolved
docusaurus/docs/advanced-adhoc-fIlters.md Outdated Show resolved Hide resolved
docusaurus/docs/advanced-adhoc-fIlters.md Outdated Show resolved Hide resolved
@torkelo torkelo merged commit 24301b1 into main Oct 3, 2023
2 checks passed
@torkelo torkelo deleted the adhoc-filter-docs branch October 3, 2023 09:08
@grafanabot
Copy link
Contributor

🚀 PR was released in v1.12.0 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
minor Increment the minor version when merged released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants