Conversation
buraizu
left a comment
buraizu
left a comment
There was a problem hiding this comment.
Thanks for the PR @jeff-morgan-dd, but some of the new links don't seem relevant to the pages they're being added to. For example:
- content/en/metrics/custom_metrics/_index.md — "How we centralize and remediate risks with Datadog Case Management" (Case Management ≠ custom metrics)
- content/en/dashboards/_index.md — "Measure and improve mobile app startup performance with Datadog RUM" (RUM mobile launches ≠ dashboards)
- content/en/incident_response/on-call/_index.md — "Protect your OCI resources with Datadog Cloud Security" (cloud security ≠ on-call)
- content/en/metrics/distributions.md — "Configuring JavaScript caches for better performance" (JS caching ≠ distribution metrics)
- content/en/notebooks/_index.md — "Monitor Karpenter with Datadog" (Karpenter monitoring ≠ notebooks)
Could you please verify that the links are being added as expected?
Additionally, there seem to be some extraneous blank lines added to the frontmatter of some files. If those aren't intentional, it may be better to remove them for consistency. Let me know if you have any questions!
|
Thanks for checking in on these, @buraizu. These were added as intended, in that blog links were added to pages that were linked to in a particular blog post. (I did use the blog linker script for this, but went through and reviewed all the additions after running the script, and just re-confirmed on the examples you gave that the script worked as expected). Definitely agree with you that some of these seem tangential/unrelated, though. I'm happy to remove those if it seems like it would be confusing for a user. What do you think? I'll go back and remove the extra lines too, once we're in agreement on the links. |
|
@jeff-morgan-dd thanks for following up. After spot-checking some of the flagged examples, I think they are potentially confusing to users. For example:
Since the blog does not give any information about custom metrics, it seems out-of-place and potentially confusing at the top of the custom metrics "Further reading" links:
This applies to every kind of data in Datadog, and this link seems likewise out-of-place and potentially confusing on the dashboards page:
|
|
@buraizu Thanks Bryce! This feedback is really helpful and all makes sense. I will remove the blog links that are out of place. That's a really good point about the location of the links too, i will take a look at those. I thought it was more consistent as I was going through the output initially, but now I see that it's not. I'll inquire about the logic there. Will go through and make the changes and delete extraneous lines, and request re-review when ready. Thanks again for going through this large PR. |
jeff-morgan-dd
force-pushed
the
jeff.morgan/update-blog-links-apr-26
branch
from
9d6487b to
c956132
Compare
buraizu
left a comment
buraizu
left a comment
There was a problem hiding this comment.
Thanks @jeff-morgan-dd, just flagging some additional links that seem tangential/unrelated to the doc pages they're being added to. I'm open to reconsidering any of these changes if I've missed some connection between the blog and the doc page.
Additionally, there still seems to be some unintentional reordering that breaks the established convention (Documentation/Learning Center links first, then Blogs, then External Sites/Release Notes). The reordering appears to follow alphabetical-by-URL logic that doesn't match what writers have intentionally set up. Examples:
- dora_metrics/_index.md: Moves the Release Notes link from between Doc links to below all Blogs, and moves existing Blog links to the bottom.
- service_level_objectives/_index.md: Moves the Terraform External Site link to the very end, after new Blogs. Existing Blog links are reshuffled.
- synthetics/browser_tests/_index.md: Blog links moved from above Documentation links to below them. The Terraform External Site link moved to the bottom.
- logs/_index.md: The Architecture Center link moved from between Blog links to after all Blogs.
- real_user_monitoring/_index.md: Two existing blog links removed from the top and re-added at the bottom in a different position relative to existing entries.
- security/ai_guard/_index.md: Blog ordering swapped (the LLM guardrails blog moved below the AI Guard blog).
- synthetics/mobile_app_testing/_index.md: "Best practices for creating end-to-end tests" blog moved from above Doc links to below them.
Since readers scan Further Reading sections quickly, grouping by type (docs together, blogs together) and having the most relevant links first can make the process easier for them. Arbitrary reordering might degrade the reading experience.
Thanks again, and let me know if you have any questions or feedback!
Co-authored-by: Bryce Eadie <bryce.eadie@datadoghq.com>
Co-authored-by: Bryce Eadie <bryce.eadie@datadoghq.com>
Co-authored-by: Bryce Eadie <bryce.eadie@datadoghq.com>
Co-authored-by: Bryce Eadie <bryce.eadie@datadoghq.com>
Co-authored-by: Bryce Eadie <bryce.eadie@datadoghq.com>
Co-authored-by: Bryce Eadie <bryce.eadie@datadoghq.com>
Co-authored-by: Bryce Eadie <bryce.eadie@datadoghq.com>
buraizu
left a comment
buraizu
left a comment
There was a problem hiding this comment.
Thanks for following up @jeff-morgan-dd, and apologies — it seems that I missed some tangential/low-relevance links in my last review pass. I've now flagged what I think are all the blogs that don't add much value to their respective further reading sections. In cases where there seems to be relevance at a surface level, I've mentioned the specific reasoning for a link's removal. Happy to reconsider any of these if you have a different perspective.
...n/incident_response/incident_management/setup_and_configuration/integrations/slack/_index.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Bryce Eadie <bryce.eadie@datadoghq.com>
|
@buraizu Thanks Bryce for going through these! The notes were really helpful - edits applied. |
2 participants
What does this PR do? What is the motivation?
Adds all outstanding, unadded blog links since the last linking PR.
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.
AI assistance
Additional notes