KAFKA-20050: Add syntax highlighting for code blocks and commands#21845
Open
gomudayya wants to merge 1 commit intoapache:trunkfrom
Open
KAFKA-20050: Add syntax highlighting for code blocks and commands#21845gomudayya wants to merge 1 commit intoapache:trunkfrom
gomudayya wants to merge 1 commit intoapache:trunkfrom
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Added language tags (e.g.,bash, java) to fenced code blocks in the getting-started directory under docs/.
I verified the syntax highlighting locally by building and running the kafka-site project.
[ sample image 1 ]
[ sample image 2 ]
A few questions:
I understand that the kafka repo's docs/ is the source of truth, so I submitted this PR here rather than to kafka-site. Is this the right approach?
This PR targets trunk, so I assume it will be synced to kafka-site when 4.3 is released. Should I also open a separate PR for the 4.2 branch to apply this to the currently released version?
To keep this PR small and focused, I've only applied syntax highlighting to the getting-started directory for now. If this approach looks good, would it be okay for me to handle the remaining directories in follow-up PRs? Or would you prefer a single PR covering all docs?
Any feedback is welcome. Thanks for reviewing!
cc @mimaison