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

Docs: Add thresholds shared content #87009

Merged
merged 5 commits into from Apr 30, 2024

Conversation

imatwawana
Copy link
Collaborator

This PR adds shared files for the thresholds options for visualizations. Two files have been added to cover the two most common sets of options. Using two shared files ensures two things:

  1. Content remains consistent across visualizations that share the same options
  2. Users reading about a visualization don't have to figure out which options don't apply to a specific visualization because they'll only be presented with the ones that apply.

This PR:

  • Adds and updates shared files for thresholds content (2)
  • Adds shared files to appropriate visualizations

@imatwawana imatwawana added type/docs no-changelog Skip including change in changelog/release notes backport v11.0.x Mark PR for automatic backport to v11.0.x labels Apr 26, 2024
@imatwawana imatwawana added this to the 11.1.x milestone Apr 26, 2024
@imatwawana imatwawana self-assigned this Apr 26, 2024
@imatwawana imatwawana requested a review from Eve832 as a code owner April 26, 2024 18:08
@imatwawana imatwawana requested review from a team, leeoniya and drew08t and removed request for Eve832 and a team April 26, 2024 18:08
Copy link
Contributor

This PR must be merged before a backport PR will be created.

1 similar comment
Copy link
Contributor

This PR must be merged before a backport PR will be created.

@nmarrs nmarrs changed the title Docs: add thresholds shared content Docs: Add thresholds shared content Apr 26, 2024
Copy link
Contributor

@nmarrs nmarrs left a comment

Choose a reason for hiding this comment

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

nice!

comments: |
There are two thresholds shared files, thresholds-options-1.md and thresholds-options-2.md, to cover the most common combinations of options.
Using two shared files ensures that content remains consistent across visualizations that share the same options and users don't have to figure out which options apply to a specific visualization when reading that content.
This file is used in the following visualizations: bar chart, candlestick, time series, trend
Copy link
Contributor

Choose a reason for hiding this comment

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

❤️

Copy link
Collaborator

@codeincarnate codeincarnate left a comment

Choose a reason for hiding this comment

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

Looks good!

@imatwawana imatwawana merged commit 406fe8c into main Apr 30, 2024
11 checks passed
@imatwawana imatwawana deleted the ihm/260424-thresholds-shared-content branch April 30, 2024 20:33
grafana-delivery-bot bot pushed a commit that referenced this pull request Apr 30, 2024
* Added thresholds shared files

* Added shared files to visualizations and updated shared files

* Removed future tense

* Fixed prettier

(cherry picked from commit 406fe8c)
imatwawana added a commit that referenced this pull request Apr 30, 2024
Docs: Add thresholds shared content (#87009)

* Added thresholds shared files

* Added shared files to visualizations and updated shared files

* Removed future tense

* Fixed prettier

(cherry picked from commit 406fe8c)

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport v11.0.x Mark PR for automatic backport to v11.0.x no-changelog Skip including change in changelog/release notes type/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants