Skip to content

Update subs documentation #2066

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

Merged
merged 2 commits into from
Oct 17, 2025
Merged

Update subs documentation #2066

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d2d78a2
Update substitutions.md
theletterf Oct 17, 2025
db094f9
Edit frontmatter.md
theletterf Oct 17, 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
7 changes: 7 additions & 0 deletions docs/syntax/frontmatter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,16 @@ applies_to: <3>
products: <4>
- id: apm-agent
- id: edot-sdk
sub: <5>
key: value
---
```

1. [`navigation_title`](#navigation-title)
2. [`description`](#description)
3. [`applies_to`](#applies-to)
4. [`products`](#products)
5. [`sub`](#subs)

## Navigation Title

Expand Down Expand Up @@ -83,3 +86,7 @@ The products frontmatter is a list of objects, each object has an `id` field.
| `search-ui` | Search UI |
| `security` | Elastic Security |
| `winlogbeat` | Winlogbeat |

## Subs

Use the `sub` field to define local substitutions. Refer to [Substitutions](substitutions.md) for more information.
2 changes: 1 addition & 1 deletion docs/syntax/substitutions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ In both cases the yaml to define them is as followed:


```yaml
subs:
sub:
key: value
another-var: Another Value
```
Expand Down
Loading