[GitHub] [incubator-druid] legoscia opened a new pull request #8079: Fix documentation formatting

[GitBox <gi...@apache.org>]

legoscia opened a new pull request #8079: Fix documentation formatting
URL: https://github.com/apache/incubator-druid/pull/8079
 
 
   The Markdown dialect used when publishing the documentation to the web
   site is much more sensitive than Github-flavoured Markdown.  In
   particular, it requires an empty line before code blocks (unless the
   code block starts right after a heading), otherwise the code block
   gets formatted in-line with the previous paragraph.  Likewise for
   bullet-point lists.
   
   See for example the current version of https://druid.apache.org/docs/latest/querying/filters.html. It contains a paragraph that looks like this:
   
   > The following bound filter expresses the condition `21 <= age <= 31`: `json { "type": "bound", "dimension": "age", "lower": "21", "upper": "31" , "ordering": "numeric" } `
   
   though the intention was for the piece of JSON to appear as a code block with preserved newlines:
   
   > The following bound filter expresses the condition `21 <= age <= 31`:
   >
   >```json
   >{
   >    "type": "bound",
   >    "dimension": "age",
   >    "lower": "21",
   >    "upper": "31" ,
   >    "ordering": "numeric"
   >}
   >```
   
   
   This PR has:
   - [x] been self-reviewed.
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org