-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Update automated analysis page after insight banner design update #31189
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?
Conversation
📝 Documentation Team Review RequiredThis pull request requires approval from the @DataDog/documentation team before it can be merged. Please ensure your changes follow our documentation guidelines and wait for a team member to review and approve your changes. |
9cd8bb5
to
f700a34
Compare
Preview links (active after the
|
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.
Left a couple thoughts!
- In the **Insights** banner at the top of the page when you're scoped to a specific service | ||
{{< img src="profiler/profiling_automated_analysis_banner.png" alt="The Automated Analysis banner displaying insights detected for a given service" style="width:100%;">}} | ||
|
||
- In the **Insights** column within the service list | ||
{{< img src="profiler/profiling_automated_analysis_column.png" alt="The Automated Analysis column displaying insights detected for a given service within the service list" style="width:100%;">}} | ||
- In the **Insights** banner when the service list is displayed | ||
{{< img src="profiler/profiling_automated_analysis_column.png" alt="The Automated Analysis banner displaying insights detected for a given service list" 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.
Does it still make sense to keep these 2 bullet points now that the placement is the same for both? (top right corner)
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 think it still makes sense as the use case is not quite the same
We have Insights for a defined service vs Insights for a list of services
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.
Yes, although this subsection seems to inform only on where you can find insights, not what kind of insights they are. In this case, it's the same placement in the page so it feels a bit redundant to me
For explaining what kind of insights these are (the 2 use cases), I believe this can be done with very few words added in the UI to alleviate all confusion, for example:
when no service is selected | when a service is selected |
---|---|
![]() |
![]() |
@@ -33,11 +33,11 @@ This reduces the profiling expertise needed to identify and resolve performance | |||
## Explore insights | |||
Access Automated Analysis from the [Profile explorer][1]. Insights are displayed: | |||
|
|||
- In the **Top Insights** banner at the top of the page when you're scoped to a specific service | |||
- In the **Insights** banner at the top of the page when you're scoped to a specific service |
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.
f148e3b
to
79eaf44
Compare
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.
Hi @c-moller! Thanks for opening this PR. The content changes looks good. Our updates go through the translation pipeline to get translated, so even though you updated the Korean in this PR, it might get revert back to the previous text until it goes through the translation process.
Could you change the image filenames? Otherwise there will be caching issues and the old images will still show up.
79eaf44
to
9d1ad18
Compare
What does this PR do? What is the motivation?
The design for the Insights banner has been updated.
This PR aims to reflect this change in the profiling automated analysis documentation.
QA link: https://docs-staging.datadoghq.com/carys.moller/update-insights-design/profiler/automated_analysis
Merge instructions
Merge readiness:
For Datadog employees:
Your branch name MUST follow the
<name>/<description>
convention and include the forward slash (/
). Without this format, your pull request will not pass 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.
[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.
Additional notes