Skip to content

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

c-moller
Copy link
Contributor

@c-moller c-moller commented Aug 20, 2025

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:

  • Ready for merge

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

@github-actions github-actions bot added the Images Images are added/removed with this PR label Aug 20, 2025
Copy link
Contributor

github-actions bot commented Aug 20, 2025

📝 Documentation Team Review Required

This 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.

@c-moller c-moller force-pushed the carys.moller/update-insights-design branch from 9cd8bb5 to f700a34 Compare August 20, 2025 09:28
Copy link
Contributor

Preview links (active after the build_preview check completes)

Modified Files

@c-moller c-moller requested a review from a team August 20, 2025 09:37
@c-moller c-moller marked this pull request as ready for review August 20, 2025 10:09
@c-moller c-moller requested a review from a team as a code owner August 20, 2025 10:09
Copy link

@MaximeLaplace MaximeLaplace left a 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!

Comment on lines 36 to 40
- 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%;">}}

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)

Copy link
Contributor Author

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

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
image image

@@ -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

Choose a reason for hiding this comment

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

banner sounds like "full width content" to me, I would not call this one a banner, section sounds more accurate to me.
Letting the native english speakers chime in though!

Image

@c-moller c-moller force-pushed the carys.moller/update-insights-design branch 3 times, most recently from f148e3b to 79eaf44 Compare August 20, 2025 15:33
@maycmlee maycmlee self-assigned this Aug 20, 2025
Copy link
Contributor

@maycmlee maycmlee left a 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.

@c-moller c-moller force-pushed the carys.moller/update-insights-design branch from 79eaf44 to 9d1ad18 Compare August 21, 2025 07:55
@c-moller c-moller requested a review from maycmlee August 21, 2025 07:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Images Images are added/removed with this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants