Skip to content

Restructure Synthetics Notifications - Template Variables #33627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
git-thuerk-done wants to merge 10 commits into from
Closed

Restructure Synthetics Notifications - Template Variables #33627

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
076623d
updating synthetics template variables
git-thuerk-done Dec 30, 2025
54a97d1
update step summary
git-thuerk-done Dec 30, 2025
7af30d6
Merge branch 'master' into aliciathuerk/syn-updates-TEE
git-thuerk-done Dec 30, 2025
f9b7208
updates from Thang's review
git-thuerk-done Dec 30, 2025
80a325c
remove examples
git-thuerk-done Dec 31, 2025
d02f3b5
add shortcode, yaml, and html
git-thuerk-done Dec 31, 2025
397b597
add table of contents to html
git-thuerk-done Dec 31, 2025
125fd15
removing files
git-thuerk-done Dec 31, 2025
a974d51
removing files
git-thuerk-done Dec 31, 2025
e74159b
add http
git-thuerk-done Dec 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
919 changes: 13 additions & 906 deletions content/en/synthetics/notifications/template_variables.md
View file
Open in desktop

Large diffs are not rendered by default.

444 changes: 444 additions & 0 deletions data/synthetics/template_variables.yaml
View file
Open in desktop

Large diffs are not rendered by default.

28 changes: 28 additions & 0 deletions layouts/partials/synthetics/template-variables-execution.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{{/*
Renders Test Execution Variables from data/synthetics/template_variables.yaml
Usage: {{ partial "synthetics/template-variables-execution.html" . }}
*/}}

{{ $data := .Site.Data.synthetics.template_variables }}

{{ with $data.test_execution }}
<p>{{ .description | markdownify }}</p>

<div class="code-tabs">
<ul class="nav nav-tabs d-flex"></ul>
<div class="tab-content">
{{ range $idx, $cat := .categories }}
<div data-lang="{{ $cat.name | lower | anchorize | replace "-" "" }}" class="tab-pane fade" role="tabpanel" title="{{ $cat.name }}">
{{ with $cat.note }}<p><em>{{ . | markdownify }}</em></p>{{ end }}
<dl class="template-variables">
{{ range $cat.variables }}
<dt><code>{{ printf "{{%s}}" .path }}</code></dt>
<dd>{{ .description | markdownify }}</dd>
{{ end }}
</dl>
</div>
{{ end }}
</div>
</div>
{{ end }}

29 changes: 29 additions & 0 deletions layouts/partials/synthetics/template-variables-result.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{{/*
Renders Result Variables from data/synthetics/template_variables.yaml
Usage: {{ partial "synthetics/template-variables-result.html" . }}
*/}}

{{ $data := .Site.Data.synthetics.template_variables }}

{{ with $data.result_variables }}
<p>{{ .description | markdownify }}</p>

<div class="code-tabs">
<ul class="nav nav-tabs d-flex"></ul>
<div class="tab-content">
{{ range $idx, $cat := .categories }}
<div data-lang="{{ $cat.name | lower | anchorize | replace "-" "" }}" class="tab-pane fade" role="tabpanel" title="{{ $cat.name }}">
{{ with $cat.note }}<p>{{ . | markdownify }}</p>{{ end }}
{{ with $cat.location }}<p>Located at <code>{{ printf "{{%s}}" . }}</code>:</p>{{ end }}
<dl class="template-variables">
{{ range $cat.variables }}
<dt><code>{{ .path }}</code></dt>
<dd>{{ .description | markdownify }}</dd>
{{ end }}
</dl>
</div>
{{ end }}
</div>
</div>
{{ end }}

63 changes: 63 additions & 0 deletions layouts/partials/synthetics/template-variables-steps.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
{{/*
Renders Step Extracted Variables from data/synthetics/template_variables.yaml
Usage: {{ partial "synthetics/template-variables-steps.html" . }}
*/}}

{{ $data := .Site.Data.synthetics.template_variables }}

{{ with $data.step_extracted_variables }}
<p>{{ .description | markdownify }}</p>

<div class="code-tabs">
<ul class="nav nav-tabs d-flex"></ul>
<div class="tab-content">
{{ range $idx, $cat := .categories }}
<div data-lang="{{ $cat.name | lower | anchorize | replace "-" "" }}" class="tab-pane fade" role="tabpanel" title="{{ $cat.name }}">

{{ with $cat.note }}<p><em>{{ . | markdownify }}</em></p>{{ end }}

{{/* Handle categories with groups */}}
{{ with $cat.groups }}
{{ range . }}
<h4>{{ .name }}</h4>
{{ with .note }}<p><em>{{ . | markdownify }}</em></p>{{ end }}
<dl class="template-variables">
{{ range .variables }}
<dt><code>{{ .path }}</code></dt>
<dd>{{ .description | markdownify }}</dd>
{{ end }}
</dl>
{{ end }}
{{ end }}

{{/* Handle categories with direct variables (no groups) */}}
{{ with $cat.variables }}
<dl class="template-variables">
{{ range . }}
<dt><code>{{ .path }}</code></dt>
<dd>{{ .description | markdownify }}</dd>
{{ end }}
</dl>
{{ end }}

{{/* Handle categories with subtypes (Network tests, Protocol tests) */}}
{{ with $cat.subtypes }}
{{ range . }}
<details class="collapse-content">
<summary><h4 style="display: inline;">{{ .name }}</h4></summary>
<dl class="template-variables">
{{ range .variables }}
<dt><code>{{ .path }}</code></dt>
<dd>{{ .description | markdownify }}</dd>
{{ end }}
</dl>
</details>
{{ end }}
{{ end }}

</div>
{{ end }}
</div>
</div>
{{ end }}

49 changes: 49 additions & 0 deletions layouts/partials/synthetics/template-variables-summary.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
{{/*
Renders Step Summary from data/synthetics/template_variables.yaml
Usage: {{ partial "synthetics/template-variables-summary.html" . }}
*/}}

{{ $data := .Site.Data.synthetics.template_variables }}

{{ with $data.step_summary }}
<p>{{ .description | markdownify }}</p>

<p>Each step exposes the following properties:
{{ range $idx, $prop := .step_properties }}{{ if $idx }}, {{ end }}<code>{{ $prop }}</code>{{ end }}.
</p>

<p>You can reference steps in three ways:</p>

{{ range .reference_methods }}
<h4>{{ .name }}</h4>
<p>{{ .description | markdownify }}{{ if .example }}: <code>{{ .example }}</code>{{ end }}</p>

{{ with .examples }}
<table>
<thead>
<tr>
<th>Syntax</th>
<th>Description</th>
</tr>
</thead>
<tbody>
{{ range . }}
<tr>
<td><code>{{ .syntax }}</code></td>
<td>{{ .description | markdownify }}</td>
</tr>
{{ end }}
</tbody>
</table>
{{ end }}
{{ end }}

<h4>Accessing step properties</h4>
<p>Combine any reference method with a property:</p>
<ul>
{{ range .usage_examples }}
<li><code>{{ printf "{{%s}}" .path }}</code> - {{ .description | markdownify }}</li>
{{ end }}
</ul>
{{ end }}

155 changes: 155 additions & 0 deletions layouts/partials/synthetics/template-variables.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
{{/*
Renders Synthetics template variables from data/synthetics/template_variables.yaml
Usage: {{ partial "synthetics/template-variables.html" . }}
*/}}

{{ $data := .Site.Data.synthetics.template_variables }}

{{/* Test Execution Variables */}}
{{ with $data.test_execution }}
<h3 id="test-execution-variables">Test execution variables</h3>
<p>{{ .description | markdownify }}</p>

<div class="code-tabs">
<ul class="nav nav-tabs d-flex"></ul>
<div class="tab-content">
{{ range $idx, $cat := .categories }}
<div data-lang="{{ $cat.name | lower | anchorize | replace "-" "" }}" class="tab-pane fade" role="tabpanel" title="{{ $cat.name }}">
{{ with $cat.note }}<p><em>{{ . | markdownify }}</em></p>{{ end }}
<dl class="template-variables">
{{ range $cat.variables }}
<dt><code>{{ printf "{{%s}}" .path }}</code></dt>
<dd>{{ .description | markdownify }}</dd>
{{ end }}
</dl>
</div>
{{ end }}
</div>
</div>
{{ end }}

{{/* Result Variables */}}
{{ with $data.result_variables }}
<h3 id="result-variables">Result variables</h3>
<p>{{ .description | markdownify }}</p>

<div class="code-tabs">
<ul class="nav nav-tabs d-flex"></ul>
<div class="tab-content">
{{ range $idx, $cat := .categories }}
<div data-lang="{{ $cat.name | lower | anchorize | replace "-" "" }}" class="tab-pane fade" role="tabpanel" title="{{ $cat.name }}">
{{ with $cat.note }}<p>{{ . | markdownify }}</p>{{ end }}
{{ with $cat.location }}<p>Located at <code>{{ printf "{{%s}}" . }}</code>:</p>{{ end }}
<dl class="template-variables">
{{ range $cat.variables }}
<dt><code>{{ .path }}</code></dt>
<dd>{{ .description | markdownify }}</dd>
{{ end }}
</dl>
</div>
{{ end }}
</div>
</div>
{{ end }}

{{/* Step Extracted Variables */}}
{{ with $data.step_extracted_variables }}
<h3 id="variables-extracted-by-steps">Variables extracted by steps</h3>
<p>{{ .description | markdownify }}</p>

<div class="code-tabs">
<ul class="nav nav-tabs d-flex"></ul>
<div class="tab-content">
{{ range $idx, $cat := .categories }}
<div data-lang="{{ $cat.name | lower | anchorize | replace "-" "" }}" class="tab-pane fade" role="tabpanel" title="{{ $cat.name }}">

{{ with $cat.note }}<p><em>{{ . | markdownify }}</em></p>{{ end }}

{{/* Handle categories with groups */}}
{{ with $cat.groups }}
{{ range . }}
<h4>{{ .name }}</h4>
{{ with .note }}<p><em>{{ . | markdownify }}</em></p>{{ end }}
<dl class="template-variables">
{{ range .variables }}
<dt><code>{{ .path }}</code></dt>
<dd>{{ .description | markdownify }}</dd>
{{ end }}
</dl>
{{ end }}
{{ end }}

{{/* Handle categories with direct variables (no groups) */}}
{{ with $cat.variables }}
<dl class="template-variables">
{{ range . }}
<dt><code>{{ .path }}</code></dt>
<dd>{{ .description | markdownify }}</dd>
{{ end }}
</dl>
{{ end }}

{{/* Handle categories with subtypes (Network tests, Protocol tests) */}}
{{ with $cat.subtypes }}
{{ range . }}
<details class="collapse-content">
<summary><h4 style="display: inline;">{{ .name }}</h4></summary>
<dl class="template-variables">
{{ range .variables }}
<dt><code>{{ .path }}</code></dt>
<dd>{{ .description | markdownify }}</dd>
{{ end }}
</dl>
</details>
{{ end }}
{{ end }}

</div>
{{ end }}
</div>
</div>
{{ end }}

{{/* Step Summary */}}
{{ with $data.step_summary }}
<h3 id="step-summary">Step summary</h3>
<p>{{ .description | markdownify }}</p>

<p>Each step exposes the following properties:
{{ range $idx, $prop := .step_properties }}{{ if $idx }}, {{ end }}<code>{{ $prop }}</code>{{ end }}.
</p>

<p>You can reference steps in three ways:</p>

{{ range .reference_methods }}
<h4>{{ .name }}</h4>
<p>{{ .description | markdownify }}{{ if .example }}: <code>{{ .example }}</code>{{ end }}</p>

{{ with .examples }}
<table>
<thead>
<tr>
<th>Syntax</th>
<th>Description</th>
</tr>
</thead>
<tbody>
{{ range . }}
<tr>
<td><code>{{ .syntax }}</code></td>
<td>{{ .description | markdownify }}</td>
</tr>
{{ end }}
</tbody>
</table>
{{ end }}
{{ end }}

<h4>Accessing step properties</h4>
<p>Combine any reference method with a property:</p>
<ul>
{{ range .usage_examples }}
<li><code>{{ printf "{{%s}}" .path }}</code> - {{ .description | markdownify }}</li>
{{ end }}
</ul>
{{ end }}
Binary file added static/images/synthetics/notifications/action_tab.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading