docs(vrl): add example syntax for valid expressions. #21963
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bfung
added
domain: external docs
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Datadog ReportBranch report: ✅ 0 Failed, 7 Passed, 0 Skipped, 25.45s Total Time |
pront
approved these changes
Dec 5, 2024
neko-dd
approved these changes
Dec 5, 2024
| remap: syntax: expressions: { | ||
| title: "Expressions" | ||
| description: """ | ||
| VRL programs are made up of literal and dynamic expressions, described more in detail below. Expressions can be separated by newline or semicolon in any combination. |
There was a problem hiding this comment.
Suggested change
| VRL programs are made up of literal and dynamic expressions, described more in detail below. Expressions can be separated by newline or semicolon in any combination. | |
| VRL programs are made up of literal and dynamic expressions, described more in detail below. Expressions can be separated by newlines or semicolons in any combination. |
pront
pushed a commit
that referenced
this pull request
Dec 6, 2024
* docs(vrl): add example syntax for valid expressions. * fix spelling * fix grammar and trailing whitespace from 'cargo vdev check fmt' * run 'cue fmt' to pass 'make check-docs'
jszwedko
pushed a commit
that referenced
this pull request
Dec 9, 2024
* docs(vrl): add example syntax for valid expressions. * fix spelling * fix grammar and trailing whitespace from 'cargo vdev check fmt' * run 'cue fmt' to pass 'make check-docs'
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Add documentation for valid VRL syntax using newline and/or semicolons.
Change Type
Is this a breaking change?
How did you test this PR?
Verified the VRL syntax works in the VRL Playground [share]
Create and test .cue file documentation:
Then open browser to local site at http://localhost:1313/docs/reference/vrl/expressions/#syntax.
Does this PR include user facing changes?
Checklist
Cargo.lock), pleaserun
dd-rust-license-tool writeto regenerate the license inventory and commit the changes (if any). More details here.References
Discord chat [link]: