Skip to content

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

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.

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

Conversation

alexakreizinger
Copy link
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.

@alexakreizinger alexakreizinger requested review from a team as code owners July 8, 2025 22:18
Copy link
Contributor

@cnorris-cs cnorris-cs left a comment

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 <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
@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