[KAFKA-5496] Consistency in documentation

• Type: Improvement
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Component/s: documentation
• Assignee: Tom Bentley
• Reporter: Tom Bentley
• Created: 22/Jun/17 11:04
• Updated: 22/Jun/17 11:04

Description

The documentation is full of inconsistencies, including

• Some tool examples feature a > prompt, but others do not.
• Code/config in <pre> tags with different amounts of indentation (often there's no actual need for indentation at all)
• Missing or inconsistent typographical conventions for file and script names, class and method names etc, making some of the documentation harder to read.
• <pre class="brush: xml;"> tags for syntax highlighting, but no syntax highlighting on the site.