Skip to content
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

Fix documentation formatting #8079

Merged
merged 1 commit into from
Jul 15, 2019
Merged

Fix documentation formatting #8079

merged 1 commit into from
Jul 15, 2019

Conversation

legoscia
Copy link
Contributor

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:

{
   "type": "bound",
   "dimension": "age",
   "lower": "21",
   "upper": "31" ,
   "ordering": "numeric"
}

This PR has:

  • been self-reviewed.

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.
@fjy fjy merged commit 179253a into apache:master Jul 15, 2019
@legoscia legoscia deleted the doc-formatting branch July 16, 2019 13:23
clintropolis pushed a commit that referenced this pull request Jul 24, 2019
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.
legoscia added a commit to legoscia/incubator-druid that referenced this pull request Jul 24, 2019
Add empty lines before bulleted lists and code blocks, to ensure that
they show up properly on the web site.  See also apache#8079.
@clintropolis clintropolis added this to the 0.15.1 milestone Jul 24, 2019
himanshug pushed a commit that referenced this pull request Jul 24, 2019
Add empty lines before bulleted lists and code blocks, to ensure that
they show up properly on the web site.  See also #8079.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants