Skip to content

Conversation

@git-thuerk-done
Copy link
Contributor

@git-thuerk-done git-thuerk-done commented Dec 31, 2025

What does this PR do? What is the motivation?

Synthetics Template Variables Documentation Refactor

  • Completely restructured the template variables page to separate data from presentation:
  • New Data File: data/synthetics/template_variables.yaml
  • Contains all 100+ template variable definitions in structured YAML format
  • Organized into sections: test_execution, result_variables, step_extracted_variables, step_summary

Easier to maintain, validate, and potentially generate from code
New Partials:

  1. layouts/partials/synthetics/template-variables-execution.html - Renders test execution variables
  2. layouts/partials/synthetics/template-variables-result.html - Renders result variables
  3. layouts/partials/synthetics/template-variables-steps.html - Renders step extracted variables
  4. layouts/partials/synthetics/template-variables-summary.html - Renders step summary
  5. Updated: content/en/synthetics/notifications/template_variables.md

Uses partials to render variable documentation from the YAML data file

  • Section headings remain in markdown for proper table of contents generation

Benefits of Template Variables Refactor

  1. Maintainability: Variable data is now in one structured YAML file
  2. Reusability: Data can be used by other templates or tooling
  3. Validation: YAML structure can be validated/linted
  4. Localization: Easier to create translated versions of the data file
  5. Cleaner content: Markdown file focuses on narrative content while partials handle rendering

Merge instructions

Merge readiness:

  • Ready for merge

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.

Additional notes

@git-thuerk-done git-thuerk-done requested a review from a team as a code owner December 31, 2025 15:55
@github-actions github-actions bot added the Images Images are added/removed with this PR label Dec 31, 2025
@git-thuerk-done git-thuerk-done added the WORK IN PROGRESS No review needed, it's a wip ;) label Dec 31, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 31, 2025

Preview links (active after the build_preview check completes)

Modified Files

@git-thuerk-done git-thuerk-done requested a review from a team as a code owner December 31, 2025 16:51
@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Dec 31, 2025
@git-thuerk-done
Copy link
Contributor Author

git-thuerk-done commented Dec 31, 2025

Replaced by #33630

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 Images Images are added/removed with this PR WORK IN PROGRESS No review needed, it's a wip ;)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants