Skip to content

Remove instances of $ from commands that don't include output - #1885

Merged
alexakreizinger merged 3 commits into
masterfrom
alexakreizinger/sc-141445/fix-formatting-errors-from-fluent-bit-docs
Jul 9, 2025
Merged

Remove instances of $ from commands that don't include output#1885
alexakreizinger merged 3 commits into
masterfrom
alexakreizinger/sc-141445/fix-formatting-errors-from-fluent-bit-docs

Conversation

@alexakreizinger

Copy link
Copy Markdown
Member

standard docs practices recommend not including $ in command snippets unless that snippet includes both input and output, in which case $ helps differentiate the two. (common linting tools like markdownlint include rules designed to find and fix this.)

this PR removes instances of $ from snippets that don't include output. in other words:


$ command

becomes

command

and

$ command1
$ command2

becomes

command1
command2

but

$ command
output
more output

remains the same.

Signed-off-by: Alexa Kreizinger <alexakreizinger@gmail.com>
Signed-off-by: Alexa Kreizinger <alexakreizinger@gmail.com>
@alexakreizinger
alexakreizinger requested review from a team as code owners July 8, 2025 22:18
Comment thread stream-processing/getting-started/hands-on.md Outdated
Comment thread stream-processing/getting-started/hands-on.md Outdated
Comment thread stream-processing/getting-started/hands-on.md Outdated
Comment thread stream-processing/getting-started/hands-on.md Outdated
Comment thread stream-processing/getting-started/hands-on.md Outdated

@cnorris-cs cnorris-cs left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left suggestions, but I've added my approval based on that to keep this moving.

Co-authored-by: Craig Norris <112565517+cnorris-cs@users.noreply.github.com>
Signed-off-by: Alexa Kreizinger <alexakreizinger@gmail.com>
@alexakreizinger
alexakreizinger merged commit 09bcd1f into master Jul 9, 2025
5 checks passed
@alexakreizinger
alexakreizinger deleted the alexakreizinger/sc-141445/fix-formatting-errors-from-fluent-bit-docs branch July 9, 2025 19:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants