[CCA-1071] ccm report schedules docs #31148
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. |
Preview links (active after the
|
ashleyyip
force-pushed
the
ashley.yip/scheduled-reports-docs
branch
from
3f11684 to
dbb771e
Compare
There was a problem hiding this comment.
Hi @ashleyyip thanks so much for your PR! I made some suggestions mainly around formatting and to cut some words where possible. I also added an image and replaced a couple of others to blur PII that included real employee names and photos.
In cloud_cost_management/reports/_index.md, can we add the new "Scheduled Reports" page to the Further reading?
Let me know if you have any questions about my feedback!
Co-authored-by: Rosa Trieu <[email protected]>
ashleyyip
force-pushed
the
ashley.yip/scheduled-reports-docs
branch
from
ff8d78e to
981dcd1
Compare
…g/documentation into ashley.yip/scheduled-reports-docs
…g/documentation into ashley.yip/scheduled-reports-docs
ashleyyip
changed the title
There was a problem hiding this comment.
[non-blocking] Bit of an optimization, but I'd prefer a screenshot here without any filters/group bys selected. The PDF report does not respect these selections, so it could be misleading, and in general it makes the visual busier, when we want the attention to go to the share menu
| - **Email recipients**: Enter email addresses. Your Datadog account is automatically added, but you can remove it by hovering over it and clicking the trash icon. | ||
| {{< img src="dashboards/scheduled_reports/add_email_recipients.png" alt="The configuration modal for editing scheduled report variables." style="width:80%;" >}} |
There was a problem hiding this comment.
[non-blocking, feel free to ignore if you disagree] It might be nice to include the note we have in the dashboards public docs:
Note: Enterprise and Pro accounts can send reports to recipients outside of their organizations.
It flags to users concerned about security that this can be used to send outside of the org. If I re-wrote that line, I might also include that orgs can control which email domains can receive reports by configuring their domain allowlist
There was a problem hiding this comment.
Added:
Note: Enterprise and Pro accounts can send reports to recipients outside of their organizations. You can control which email domains are able to receive reports by configuring your [domain allowlist][4].
| | Create/modify your schedules | Cloud Cost Report Schedules Write | | ||
| | Modify others' schedules | Cloud Cost Report Schedules Manage | | ||
|
|
||
| After a report is created, you can subscribe, unsubscribe, edit schedules, and delete reports (assuming you have the appropriate permissions). If you do not have **Cloud Cost Report Schedules Write** or **Cloud Cost Report Schedules Manage** permissions, you can still unsubscribe directly from the email. |
There was a problem hiding this comment.
If you do not have Cloud Cost Report Schedules Write or Cloud Cost Report Schedules Manage permissions, you can still unsubscribe directly from the email.
Not sure this last line is worth bringing up since there's some nuance here.
This^ sentence is only true if the recipient is also a datadog user. If you send the report to a group email like [email protected] or to an external recipient like [email protected], there is no unsubscribe link, the user will have to reach out to the report schedule owner to unsubscribe. That's because we got too many customer complaints that for a group email address, one person would unsub & then the entire group would be unsubed. We cannot tell on our side the difference between a group email & individual emails that aren't datadog users, so they all get no unsubscribe link.
There was a problem hiding this comment.
hmmm i stole it from https://docs.datadoghq.com/logs/reports/ but I see what you mean, I can delete it!
There was a problem hiding this comment.
@vjfridge @ashleyyip i think perhaps it would actually be helpful for users to explain this behavior. thoughts?
| After a report is created, you can subscribe, unsubscribe, edit schedules, and delete reports (assuming you have the appropriate permissions). If you do not have **Cloud Cost Report Schedules Write** or **Cloud Cost Report Schedules Manage** permissions, you can still unsubscribe directly from the email. | |
| After a report is created, you can subscribe, unsubscribe, edit schedules, and delete reports (assuming you have the appropriate permissions). | |
| **Note:** Only Datadog users can unsubscribe directly from the email. External recipients (including group email addresses) must contact the report schedule owner to unsubscribe, as Datadog cannot distinguish between group emails and individual external emails. |
Co-authored-by: Vickie Boettcher <[email protected]>
…g/documentation into ashley.yip/scheduled-reports-docs
What does this PR do? What is the motivation?
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