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

Add SLO dashboard panel docs #3503

Merged
merged 1 commit into from
Jan 4, 2024

Conversation

bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented Jan 4, 2024

Summary

This PR adds documentation for the following features:

Dashboard panels are discussed here in the Kibana reference. The documentation focuses on custom panels, not Elastic-provided panels. For that reason, I decided to add these docs to the SLO overview page. There's not a lot of content here—this is more of a, "hey, this feature exists if you want to use it." As you're more familiar with this area, I'd love to get your feedback, @mdbirnstiehl.

Related

To do

@bmorelli25 bmorelli25 requested a review from a team as a code owner January 4, 2024 01:26
Copy link
Contributor

github-actions bot commented Jan 4, 2024

A documentation preview will be available soon:

@bmorelli25 bmorelli25 self-assigned this Jan 4, 2024
Copy link
Contributor

mergify bot commented Jan 4, 2024

This pull request does not have a backport label. Could you fix it @bmorelli25? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Jan 4, 2024
Comment on lines +34 to +35
== SLO overview
From the SLO overview, you can see all of your SLOs and a quick summary of what's happening in each one:
Copy link
Member Author

Choose a reason for hiding this comment

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

Note that I changed this from "SLO Dashboard" to "SLO overview".

  1. I don't see any indication in the product that this is called "SLO Dashboard."
  2. I wanted to reduce confusion between this content and the new "SLO Dashboard panels." Do you think this change is okay, @mdbirnstiehl ?

@bmorelli25 bmorelli25 added backport-8.12 Automated backport with mergify and removed backport-skip Skip notification from the automated backport with mergify labels Jan 4, 2024
Copy link
Contributor

@mdbirnstiehl mdbirnstiehl left a comment

Choose a reason for hiding this comment

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

LGTM!

@bmorelli25 bmorelli25 merged commit b4f37d2 into elastic:main Jan 4, 2024
13 checks passed
mergify bot pushed a commit that referenced this pull request Jan 4, 2024
@bmorelli25 bmorelli25 deleted the slo-dashboard-widgets branch January 4, 2024 21:57
bmorelli25 added a commit that referenced this pull request Jan 4, 2024
(cherry picked from commit b4f37d2)

Co-authored-by: Brandon Morelli <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.12 Automated backport with mergify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[SLO]: Document SLO Alerts Embeddable Widget
2 participants