Tom Bentley created KAFKA-5496:
----------------------------------

             Summary: Consistency in documentation
                 Key: KAFKA-5496
                 URL: https://issues.apache.org/jira/browse/KAFKA-5496
             Project: Kafka
          Issue Type: Improvement
          Components: documentation
            Reporter: Tom Bentley
            Assignee: Tom Bentley
            Priority: Minor


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.



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

Reply via email to