docs(external docs): Emphasize the $$ rather than $ in config file. #20991
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
urseberry
approved these changes
Aug 2, 2024
Co-authored-by: Ursula Chen <[email protected]>
jszwedko
added
the
no-changelog
Merged
via the queue into
vectordotdev:master
with commit Aug 2, 2024
210ff09
64 of 66 checks passed
ym
pushed a commit
to ym/vector
that referenced
this pull request
Aug 18, 2024
…ectordotdev#20991) * docs: Emphasize the $$ rather than $ in config file. * Update website/cue/reference/remap/functions/replace.cue Co-authored-by: Ursula Chen <[email protected]> --------- Co-authored-by: Jesse Szwedko <[email protected]> Co-authored-by: Ursula Chen <[email protected]>
AndrooTheChen
pushed a commit
to discord/vector
that referenced
this pull request
Sep 23, 2024
…ectordotdev#20991) * docs: Emphasize the $$ rather than $ in config file. * Update website/cue/reference/remap/functions/replace.cue Co-authored-by: Ursula Chen <[email protected]> --------- Co-authored-by: Jesse Szwedko <[email protected]> Co-authored-by: Ursula Chen <[email protected]>
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.
Even though the replace function documentation already states that $$ should be used instead of $ in configuration files, the specific use case example does not emphasize this distinction. This can easily lead to misunderstandings, especially for newcomers. Since many people will use this in configuration files, I believe it is necessary to explicitly clarify the different usage in the specific use case example.
related issue: #20988