Cdocs pilot page #2 (Proxy RUM browser data) #29246

jhgilbert · 2025-05-08T19:50:25Z

What does this PR do? What is the motivation?

This adds the second Cdocs pilot page to the docs site, and bumps the Cdocs integration to the latest version. I'm adding these in the same PR because the pilot page demonstrates many of the integration changes that would otherwise be difficult to test.

Notes for all reviewers

Links to specific headers don't work. This is a known issue that's already fixed in a subsequent release of Cdocs (which will be QA'd with the next pilot page, along with other bug fixes).

Notes for Heston

This page shows two new (to prod, at least) features:
- Use of DD site based customization
- A different TOC for different filter choices (>=5.4.0 vs >=4.34.0)
I reworked this content a little more than I normally would, because I wanted to test a few Markdoc things. The original content was SME-submitted and then edited by me, so I don't think anyone would object.
I reorganized the customization_config directory to keep any version-specific stuff out of the way. I imagine those could add a lot of clutter otherwise.
I've QA'd the new docs page according to the Cdocs QA checklist. Let me know if I should add anything to that list.

Notes for the websites team

I've QA'd the integration changes according to the Cdocs QA checklist. Let me know if I should add anything to that list.
I added a changelog to the Cdocs integration to make it easy to review any relevant releases, please refer to that for more details on the differences between the current version on the docs site and the target version.

Merge instructions

Merge readiness:

Ready for merge

For Datadog employees:
Merge queue is enabled in this repo. Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass in 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.

To have your PR automatically merged after it receives the required reviews, add the following PR comment:

/merge

Additional notes

github-actions · 2025-05-08T19:54:11Z

Preview links (active after the `build_preview` check completes)

New or renamed files

https://docs-staging.datadoghq.com/jen.gilbert/cdocs-pilot-rum-browser-proxy/real_user_monitoring/guide/proxy-rum-data

Removed or renamed files (these should redirect)

https://docs-staging.datadoghq.com/jen.gilbert/cdocs-pilot-rum-browser-proxy/real_user_monitoring/guide/proxy-rum-data

jhgilbert · 2025-05-08T23:00:48Z

customization_config/en/option_groups/real_user_monitoring.yaml

+    default: true
+  - id: socks
+
+rum_browser_sdk_source_options:


This one to the end of the file are the new option groups, the other two just got reorganized.

jhgilbert · 2025-05-08T23:01:29Z

customization_config/en/traits/general.yaml

@@ -0,0 +1,35 @@
+traits:


This file just got renamed, it actually only has one change, flagged below.

jhgilbert · 2025-05-08T23:01:51Z

customization_config/en/traits/general.yaml

+  label: "OS"
+  internal_notes: Mobile operating system, such as Android.
+
+- id: lib_src


The only change is that I renamed this from pkg_mgr to allow for a broader range of logical values.

jhgilbert · 2025-05-08T23:02:09Z

customization_config/en/traits/software_versions.yaml

@@ -0,0 +1,5 @@
+traits:


The content of this file is new.

hestonhoffman

I left a small nit, but this is looking good to me, so I'm going to approve to unblock. This is a great page to demo how powerful cdocs is. It shows you how much we've been relying on the user to figure out which sections of a doc apply to them. Renaming that "Alternate setup" section was also a nice touch.

content/en/real_user_monitoring/guide/proxy-rum-data.mdoc.md

hestonhoffman · 2025-05-19T17:32:59Z

content/en/real_user_monitoring/guide/proxy-rum-data.mdoc.md

+
+Your Datadog intake URL should have the format `<INTAKE_ORIGIN>/<PATH><PARAMETERS>` (for example, `https://browser-intake-datadoghq.eu/api/v2/rum?ddsource=browser&...`).
+
+{% table %}


Side note: We should investigate getting Vale to ignore markdoc partial syntax

Co-authored-by: Heston Hoffman <heston.hoffman@datadoghq.com>

jhgilbert · 2025-05-19T18:57:16Z

/merge

dd-devflow · 2025-05-19T18:57:21Z

View all feedbacks in Devflow UI.

2025-05-19 18:57:21 UTC ℹ️ Start processing command /merge

2025-05-19 18:57:30 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.

2025-05-19 18:59:14 UTC ⚠️ MergeQueue: This merge request was unqueued

jen.gilbert@datadoghq.com unqueued this merge request

jhgilbert · 2025-05-19T18:59:05Z

/remove

dd-devflow · 2025-05-19T18:59:08Z

View all feedbacks in Devflow UI.

2025-05-19 18:59:08 UTC ℹ️ Start processing command /remove

2025-05-19 18:59:11 UTC ℹ️ Devflow: /remove

jhgilbert · 2025-05-19T18:59:20Z

/merge

dd-devflow · 2025-05-19T18:59:23Z

View all feedbacks in Devflow UI.

2025-05-19 18:59:23 UTC ℹ️ Start processing command /merge

2025-05-19 18:59:34 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.

2025-05-19 19:06:20 UTC ℹ️ MergeQueue: merge request added to the queue

The expected merge time in master is approximately 21m (p90).

2025-05-19 19:25:16 UTC ℹ️ MergeQueue: This merge request was merged

jhgilbert added 12 commits May 7, 2025 13:30

Rename file

f7c10e0

Broaden the pkg_mgr trait to lib_src, to include CDNs etc

b9a8273

Add required config for new filter

22c19f9

Convert Hugo shortcodes to Markdoc tags

6aa9d14

Remove Further Reading section

f6983bd

Add a trait for the RUM browser SDK version

5f0c982

Update customization config to support version numbers

482bdaf

Finish content migration

11d89e9

Customize content for the customer's DD site

016dc10

Remove duplicate paragraph

8000

d33f5f7

Use newest Cdocs integration version

d3c5205

Tweak content order

9210b20

jhgilbert added the WORK IN PROGRESS No review needed, it's a wip ;) label May 8, 2025

github-actions bot added the Guide Content impacting a guide label May 8, 2025

Update Cdocs integration version

bc65bb1

jhgilbert added editorial review Waiting on a more in-depth review and removed WORK IN PROGRESS No review needed, it's a wip ;) labels May 8, 2025

jhgilbert marked this pull request as ready for review May 8, 2025 22:53

jhgilbert requested review from a team as code owners May 8, 2025 22:53

jhgilbert commented May 8, 2025

View reviewed changes

customization_config/en/traits/software_versions.yaml

@@ -0,0 +1,5 @@

traits:

Copy link

Contributor Author

jhgilbert May 8, 2025

Choose a reason for hiding this comment

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

The content of this file is new.

hestonhoffman approved these changes May 19, 2025

View reviewed changes

Update content/en/real_user_monitoring/guide/proxy-ru 8000 m-data.mdoc.md

0faf997

Co-authored-by: Heston Hoffman <heston.hoffman@datadoghq.com>

bgdeutsch approved these changes May 19, 2025

View reviewed changes

dd-devflow bot added the mergequeue-status: waiting label May 19, 2025

dd-devflow bot added mergequeue-status: removed and removed mergequeue-status: waiting labels May 19, 2025

dd-devflow bot added mergequeue-status: waiting mergequeue-status: queued mergequeue-status: in_progress and removed mergequeue-status: removed mergequeue-status: waiting mergequeue-status: queued labels May 19, 2025

dd-mergequeue bot merged commit 0660cd0 into master May 19, 2025
23 of 32 checks passed

dd-mergequeue bot deleted the jen.gilbert/cdocs-pilot-rum-browser-proxy branch May 19, 2025 19:25

dd-devflow bot added mergequeue-status: done and removed mergequeue-status: in_progress labels May 19, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cdocs pilot page #2 (Proxy RUM browser data) #29246

Cdocs pilot page #2 (Proxy RUM browser data) #29246


		Your Datadog intake URL should have the format `<INTAKE_ORIGIN>/<PATH><PARAMETERS>` (for example, `https://browser-intake-datadoghq.eu/api/v2/rum?ddsource=browser&...`).

		{% table %}

Cdocs pilot page #2 (Proxy RUM browser data) #29246

Cdocs pilot page #2 (Proxy RUM browser data) #29246

Conversation

What does this PR do? What is the motivation?

Notes for all reviewers

Notes for Heston

Notes for the websites team

Merge instructions

Additional notes

Preview links (active after the build_preview check completes)

New or renamed files

Removed or renamed files (these should redirect)

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Preview links (active after the `build_preview` check completes)