Skip to content

EX-3105: Added documentation for Experiments Metric Sync CLI + Reorganized Experiments Page#38127

Open
danyal002 wants to merge 2 commits into
masterfrom
danyal.khan/EX-3105
Open

EX-3105: Added documentation for Experiments Metric Sync CLI + Reorganized Experiments Page#38127
danyal002 wants to merge 2 commits into
masterfrom
danyal.khan/EX-3105

Conversation

@danyal002

@danyal002 danyal002 commented Jul 13, 2026

Copy link
Copy Markdown

What does this PR do? What is the motivation?

Adds customer-facing documentation for syncing Datadog experiment metrics from YAML using the Datadog Experiments Metric Sync CLI.

This includes:

  • A new “Sync Metrics from YAML” subpage under “Create Experiment Metrics”
  • CLI installation and authentication instructions
  • A minimal YAML example
  • YAML field reference for metric sync definitions
  • Recommended plan then execute workflow
  • Example GitHub Actions workflow for CI
  • Troubleshooting guidance

The motivation is to help customers define experiment metrics in version-controlled YAML, preview changes in pull requests, and apply approved metric changes through CI instead of configuring metrics manually in the Datadog UI.

Merge readiness

  • Ready for merge

For Datadog employees:

AI assistance

Used Codex to draft and structure the documentation, based on the Metric Sync CLI behavior and existing Datadog docs patterns. Content was reviewed and adjusted manually.

Additional notes

This PR converts the existing Create Experiment Metrics page into a section by moving it to _index.md, then adds the Metric Sync page as a child page in the docs navigation.

@danyal002 danyal002 requested a review from a team as a code owner July 13, 2026 16:50
@github-actions github-actions Bot added the Architecture Everything related to the Doc backend label Jul 13, 2026
@github-actions

Copy link
Copy Markdown
Contributor

@datadog-prod-us1-5

datadog-prod-us1-5 Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Pipelines

Fix all issues with BitsAI

⚠️ Warnings

🚦 1 Pipeline job failed

DataDog/documentation | build_preview   View in Datadog   GitLab

Useful? React with 👍 / 👎

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 8d4187f | Docs | Datadog PR Page | Give us feedback!

@maycmlee maycmlee assigned maycmlee and unassigned maycmlee Jul 13, 2026
@maycmlee

maycmlee commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Created DOCS-15088 for review.

@maycmlee maycmlee added the editorial review Waiting on a more in-depth review label Jul 13, 2026
@drichards-87 drichards-87 self-requested a review July 13, 2026 23:40
@drichards-87

Copy link
Copy Markdown
Contributor

/review

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🤖 Automated review by Claude. AI-generated; verify before acting.

Overall a well-structured, scannable reference page. Minor issues below:

  • One doc gap: ratio and percentile metric types are listed as supported, but only the simple aggregation shape is documented.
  • One style nit: a hardcoded version string in the install example will age poorly.

No blockers otherwise.

Reviewed d93b8e9cf8848cc16a478a5e44392a85d248f932workflow run

Comment thread content/en/experiments/defining_metrics/metric_sync.md
Comment thread content/en/experiments/defining_metrics/metric_sync.md Outdated
Comment thread content/en/experiments/defining_metrics/metric_sync.md Outdated
Comment thread content/en/experiments/defining_metrics/metric_sync.md
Comment thread content/en/experiments/defining_metrics/metric_sync.md Outdated
Comment thread content/en/experiments/defining_metrics/metric_sync.md Outdated
Comment thread config/_default/menus/main.en.yaml Outdated
Comment thread content/en/experiments/defining_metrics/metric_sync.md Outdated
Comment thread content/en/experiments/defining_metrics/metric_sync.md
Comment thread content/en/experiments/defining_metrics/metric_sync.md
Comment thread content/en/experiments/defining_metrics/metric_sync.md Outdated
Comment thread content/en/experiments/defining_metrics/metric_sync.md
Comment thread content/en/experiments/defining_metrics/metric_sync.md Outdated
Comment thread content/en/experiments/defining_metrics/metric_sync.md Outdated
Comment thread content/en/experiments/defining_metrics/metric_sync.md
Comment thread content/en/experiments/defining_metrics/metric_sync.md
Comment thread content/en/experiments/defining_metrics/metric_sync.md
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 editorial review Waiting on a more in-depth review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants