Skip to content

Conversation

@hestonhoffman
Copy link
Contributor

@hestonhoffman hestonhoffman commented Nov 18, 2025

What does this PR do?

Replaces repetition + site-region partials in the docs with region-params to make data center updates more efficient and maintenance easier. In some cases, this means removing tabs, as tabs and region-params don't work well together.

Outside of formatting, content shouldn't have changed.

Reviewing

The main aim here is cut down on duplication. I haven't made any content changes, so no grammar/style review is needed. When reviewing:

  • Check to make sure I haven't broken anything in the output (Hugo shortcodes are correctly rendering)
  • Users in various regions are getting the correct information

Merge instructions

Merge readiness:

  • Ready for merge

@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Nov 18, 2025
@hestonhoffman hestonhoffman added DOCS-12521 skip-jira-automation Skips closing the linked Jira ticket when a PR is merged labels Nov 18, 2025
@hestonhoffman hestonhoffman marked this pull request as ready for review November 18, 2025 23:57
@hestonhoffman hestonhoffman requested review from a team as code owners November 18, 2025 23:57
@hestonhoffman hestonhoffman added editorial review Waiting on a more in-depth review logs Content changed in the log folder labels Nov 18, 2025
@hestonhoffman hestonhoffman changed the title (DOCS-12521) Batch 3: :Logs (DOCS-12521) Batch 3: Logs Nov 18, 2025
@hestonhoffman
Copy link
Contributor Author

Copy link
Contributor

@estherk15 estherk15 left a comment

Choose a reason for hiding this comment

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

Thank you so much for doing this Heston 🔥

Datadog.initialize(
with: Datadog.Configuration(
clientToken: "<client token>",
env: "<environment>",
Copy link
Contributor

Choose a reason for hiding this comment

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

This doesn't work inside the tabs, it looks like this:

env: "<environment>",<span class="js-region-param region-param" data-region-param="ios_site_swift"></span>

You can break these out into separate sections like you did in content/en/logs/log_collection/android.md

d=o.createElement(u);d.async=1;d.src=n
n=o.getElementsByTagName(u)[0];n.parentNode.insertBefore(d,n)
})(window,document,'script','https://www.datadoghq-browser-agent.com/datadog-logs-v6.js','DD_LOGS')
})(window,document,'script','https://www.datadoghq-browser-agent.com/{{< region-param key=browser_logs_cdn_path >}}','DD_LOGS')
Copy link
Contributor

Choose a reason for hiding this comment

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

Same here, the tabs break the formatting
You could list the parameter at the top of the section and use a placeholder for the code

}
```
{{< /site-region >}}
```kotlin
Copy link
Contributor

Choose a reason for hiding this comment

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

I wasn't sure if it's a big deal, but in the original formatting, everything is aligned. The refactor isn't

.useSite(DatadogSite.EU1)
.trackCrashes(true)
.build()

vs.

     .useSite(DatadogSite.EU1)
     .trackCrashes(true)
.build()

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Architecture Everything related to the Doc backend DOCS-12521 editorial review Waiting on a more in-depth review logs Content changed in the log folder skip-jira-automation Skips closing the linked Jira ticket when a PR is merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants