DSMON-988 Improve DSM Messages role creation guide clarity #31135
Conversation
✅ Documentation Team ReviewThe documentation team has approved this pull request. Thank you for your contribution! |
Preview links (active after the
|
There was a problem hiding this comment.
Hey Steven, this looks great! I made some small readability suggestions.
The one thing I want to flag is that this kind of documentation can pose an additional maintenance burden: we already have general documentation on how to create roles and assign them, and if either workflow changes, those pages are the most likely to be updated, and pages that duplicate those workflows can get missed.
If you have a good reason to duplicate it, it's not the end of the world by any means to have it, but I wanted to make sure we at least thought about whether it would be worth it first!
Co-authored-by: Janine Chan <64388808+janine-c@users.noreply.github.com>
Co-authored-by: Janine Chan <64388808+janine-c@users.noreply.github.com>
Co-authored-by: Janine Chan <64388808+janine-c@users.noreply.github.com>
|
@janine-c Thanks for the feedback and suggestions! Totally hear you on the duplication risk. We did consider that, but felt it was important to step things out explicitly here to guide users through this specific flow. We’ll be sure to keep an eye on the related documentation if things change. |
There was a problem hiding this comment.
Thanks for the additional context, @gitstevenpham! As long as it's on your radar, I'm happy to approve 🎉
https://docs-staging.datadoghq.com/steven.pham/dsm/dsm-messages-permission-setup/data_streams/messages/#creating-a-new-role-with-permissions
What does this PR do? What is the motivation?
What changed
Improved the user experience of the role creation documentation in the Data Streams Monitoring Messages setup guide. The changes make the permission setup process more accessible and easier to follow.
Why it changed
The original role creation instructions were technical and difficult to follow, especially for users who may not be familiar with Datadog's permission system. Users needed clearer, step-by-step guidance to successfully create roles and assign permissions for the Messages feature.
Where the changes occurred
content/en/data_streams/messages.md- Enhanced the "Creating a new role with permissions" sectionHow it affects the system
This is purely a documentation improvement that doesn't affect any system behavior. It provides:
The changes make it easier for users to set up the required permissions for Data Streams Monitoring Messages feature.
Merge instructions
Merge readiness: