docs(vrl): Add parse_cbor vrl function documentation #22082
+38
−1
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
|
|
github-actions
bot
added
the
domain: external docs
MiracleWisp
force-pushed
the
parse_cbor_website
branch
from
176b260 to
ca737fa
Compare
11 tasks
estherk15
approved these changes
Dec 26, 2024
jorgehermo9
reviewed
Dec 31, 2024
MiracleWisp
force-pushed
the
parse_cbor_website
branch
from
ca737fa to
4384f1c
Compare
jorgehermo9
reviewed
Jan 8, 2025
| remap: functions: parse_json: { | ||
| category: "Parse" | ||
| description: """ | ||
| Parses the `value` as CBOR (https://cbor.io). |
There was a problem hiding this comment.
is markdown syntax valid in cue? I dont know if this works
Suggested change
| Parses the `value` as CBOR (https://cbor.io). | |
| Parses the `value` as [CBOR](https://cbor.io). |
There was a problem hiding this comment.
Edit: This should work as is.
Here's an example on how we usually do URLs in docs: https://github.com/vectordotdev/vector/blob/master/website/cue/reference/remap/functions/decode_base16.cue#L6
There was a problem hiding this comment.
Moved to urls.cue and added as a link
pront
reviewed
Jan 8, 2025
| @@ -0,0 +1,36 @@ | |||
| package metadata | |||
|
|
|||
| remap: functions: parse_json: { | |||
There was a problem hiding this comment.
Suggested change
| remap: functions: parse_json: { | |
| remap: functions: parse_cbor: { |
MiracleWisp
force-pushed
the
parse_cbor_website
branch
from
4384f1c to
f26b633
Compare
pront
approved these changes
Jan 9, 2025
There was a problem hiding this comment.
Thank you @MiracleWisp 👍
And thanks @jorgehermo9 for the review.
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
Change Type
Is this a breaking change?
How did you test this PR?
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
Relates to vectordotdev/vrl#1152