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

[v10.4.x] docs: initial updates to state timeline documentation #84758

Merged
merged 1 commit into from Mar 19, 2024

Conversation

grafana-delivery-bot[bot]
Copy link
Contributor

Backport 2f53906 from #84224


What is this feature?

Updates to the state timeline docs to include:

  • how to configure a state timeline (to be added as a video)
  • supported data formats and example
  • when to use a state timeline

Why do we need this feature?

To explain to our users how to configure a state timeline easily and when to use it.

Who is this feature for?

Grafana OSS and Cloud users

Which issue(s) does this PR fix?:

Fixes #

Special notes for your reviewer:

Please check that:

  • It works as expected from a user's perspective.
  • If this is a pre-GA feature, it is behind a feature toggle.
  • The docs are updated, and if this is a notable improvement, it's added to our What's New doc.

* docs: initial updates to state timeline documentation

* docs: apply linting

* Apply suggestions from code review

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>

* docs: add feedback from PR review

* docs: apply linting

* Wording and formatting edits

* Fixed grammar

* Update docs/sources/panels-visualizations/visualizations/state-timeline/index.md

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>

* docs: add two examples for state timeline to show null values and two timestamps

* docs: add steps to configuring a state timeline

* docs: add state timeline video

* docs: add link to creating dashboards

* Changed link text and added version interpolation syntax

---------

Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
(cherry picked from commit 2f53906)
@grafana-delivery-bot grafana-delivery-bot bot added this to the 10.4.x milestone Mar 19, 2024
@grafana-delivery-bot grafana-delivery-bot bot added backport A backport PR no-changelog Skip including change in changelog/release notes type/docs labels Mar 19, 2024
@imatwawana imatwawana merged commit 80ac64c into v10.4.x Mar 19, 2024
20 checks passed
@imatwawana imatwawana deleted the backport-84224-to-v10.4.x branch March 19, 2024 16:22
@mdvictor mdvictor modified the milestones: 10.4.x, 10.4.1 Mar 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport A backport PR 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

3 participants