Adding backlog of blog links#35734
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>
* e-linds/Update installation.md with namespace context * Update content/en/containers/kubernetes/installation.md Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com> --------- Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
* move tools to new separate page, add to nav * move Toolsets section from _index.md to setup.md * clean up _index.md: remove moved sections, add tools pointer and further reading * update cross-refs in setup.md, remove redundant heading from tools.md * add toolset section headers and rewrite intro in tools.md * add Dashboards tools, reorder & create new section per #35891 * fix heading, links * add toolset descriptions to new Tools page * update from master: add alerting tools per #35941 * reorder toolsets instructions & list * split toolsets into GA and Preview lists * add short toolset setup instructions to Tools page * add link to Toolsets section from landing page * fix heading capitalization (sentence-case) * update from master: add reference tables toolset per #35140 * apply feedback from review
…ows (#35980) * [DOCS-13990] Add instrumentation rules to Windows SSI docs, update Linux - Remove preview callout from Linux instrumentation rules section - Update attributes table on Linux: rename Executable File Path to Executable Full Path, add Entry Point File - Add Define instrumentation rules section to Windows SSI page with full attributes table including IIS Application Pool - Add example use cases with annotated screenshots to both pages Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * [DOCS-13990] Address PR review feedback - Add Advanced options section to Windows page, move instrumentation rules under it - Add second example to both Linux and Windows using collapse-content menus - Fix alt text: shorten and add missing periods - Trim Entry Point File and IIS Application Pool table descriptions - Soften absolute claim in IIS Application Pool description Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * [DOCS-13990] Remove periods from alt text Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * [DOCS-13990] Use HTML tags for code and bold inside collapse-content shortcodes Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * [DOCS-13990] Add Linux example 2 image and update example text Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * [DOCS-13990] Fix missing article and style IIS Application Pool in examples Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * Apply suggestions from code review Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
* add retention info for Bits AI SRE investigations * Update content/en/data_security/data_retention_periods.md --------- Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
…35817) * Add minimum Kafka ACL permissions for Kafka Monitoring and Messages Document the minimum Kafka ACL permissions required for the Datadog Agent when connecting to ACL-enabled Kafka clusters. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Address PR review comments - Move ACL permissions section after the setup image and paragraph in _index.md - Nest Kafka ACL permissions under Prerequisites (as H3) in messages.md Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Move message reading permissions to _index.md, revert messages.md Add a second table for Read on TOPIC (message viewing) below the monitoring permissions table. Revert all changes to messages.md. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Remove messages.md, consolidate into Kafka Monitoring page Delete the separate messages.md page and add aliases for redirects. Remove the Messages nav menu entry. Update _index.md to remove the dead link to messages.md. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Revert messages.md deletion, keep ACL permissions in _index.md only Restore messages.md and nav menu to original state. ACL permissions for both monitoring and message reading are in the Kafka Monitoring page only. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Update content/en/data_streams/kafka/_index.md Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com> * Update content/en/data_streams/kafka/_index.md Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
* Add private: true to mobile vitals Cdocs pages Mark the unified client_sdks/mobile_vitals and all SDK-specific mobile vitals wrapper pages as private so they are excluded from sitemap and search. * Remove private: true from SDK-specific mobile vitals pages
* updated test tags examples * updated variable name
…35900) Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
* Updates 18 translation(s) * Reverted further_reading tags from English back to translated language * claude assist Signed-off-by: Brian Deutsch <brian.deutsch@datadoghq.com> * inject headings to backfill anchor links Signed-off-by: Brian Deutsch <brian.deutsch@datadoghq.com> --------- Signed-off-by: Brian Deutsch <brian.deutsch@datadoghq.com> Co-authored-by: webops-guacbot[bot] <214537265+webops-guacbot[bot]@users.noreply.github.com> Co-authored-by: jeff-morgan-dd <jeff.morgan@datadoghq.com> Co-authored-by: Brian Deutsch <brian.deutsch@datadoghq.com>
* Updates 52 translation(s) * claude fixes Signed-off-by: Brian Deutsch <brian.deutsch@datadoghq.com> --------- Signed-off-by: Brian Deutsch <brian.deutsch@datadoghq.com> Co-authored-by: webops-guacbot[bot] <214537265+webops-guacbot[bot]@users.noreply.github.com> Co-authored-by: Brian Deutsch <brian.deutsch@datadoghq.com>
JJ-Change-Id: mwoxlk Co-authored-by: May Lee <may.lee@datadoghq.com>
Updated note on metric streaming to clarify support for OpenTelemetry output formats.
20 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