-
Notifications
You must be signed in to change notification settings - Fork 1.2k
DOCS-10584 #28791
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
base: master
Are you sure you want to change the base?
DOCS-10584 #28791
Conversation
…or customizing dashboard
…cross eng reports, add eng reports parent pages to SLOs section
Preview links (active after the
|
content/en/service_management/service_level_objectives/ootb_dashboard.md
Outdated
Show resolved
Hide resolved
## Overview | ||
|
||
{{< img src="tracing/eng_reports/reliability_overview.mp4" video=true alt="A video scrolling through the Reliability Overview report, which includes sections for SLO Performance and Incident Trends, grouped by team" style="width:100%;" >}} | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couple of comments for the video (thanks for taking it!):
- Is the sizing standard? it looks tiny and hard to read
- We show too much scrolling of individual widgets in the SLO part
- Would be more valuable to highlight these things: click into one of the teams in the SLO table to open the side panel, change the team/service grouping at the top of the page
- Should the video be at the very top of the page? or later on?
- Are we allowed to do demo videos from org 2? I think it should be demo org so it's not sensitive data
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also wonder if a few screenshots throughout the page would be helpful vs. the video? specifically the parts in the "interact with your report" section could use visuals?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All noted! I'll push the other changes first and then work on the vids/screenshots.
## Overview | ||
|
||
{{< img src="tracing/eng_reports/scorecards_performance.mp4" video=true alt="A video scrolling through the Scorecards Performance report, which includes sections for Performance by Scorecard, Historical Trends by Scorecard, Performance by Rule, and Historical Trends by Rule" style="width:100%;" >}} | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similar feedback about this video as the one for the reliability report. I also think we should apply some filters so that the info isn't so dense. Maybe something like this int the demo org
#### Get started | ||
|
||
Before your team can use the developer overview page, a platform admin must connect the page widgets to data sources: | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It doesn't have to be an admin, as long as you have the required app builder permission so we shouldn't call out "admin"
#### Clone for further customization | ||
|
||
If the developer overview page doesn't meet your workflow needs, you can clone the page to create a customizable dashboard that lives outside of IDP. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't like highlighting "that lives outside of IDP", we can just say it's a dashboard prefilled with info from the default overview page.
I also think it's better to separate out the customization to its own section separate from the getting started steps (maybe after the page features).
What does this PR do? What is the motivation?
https://datadoghq.atlassian.net/browse/DOCS-10584
Merge instructions
Merge readiness:
For Datadog employees:
Merge queue is enabled in this repo. Your branch name MUST follow the
<name>/<description>
convention and include the forward slash (/
). Without this format, your pull request will not pass in CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
To have your PR automatically merged after it receives the required reviews, add the following PR comment:
Additional notes