You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@druid.apache.org by GitBox <gi...@apache.org> on 2022/09/19 00:33:42 UTC
[GitHub] [druid] vogievetsky opened a new pull request, #13117: fix html tags in docs
vogievetsky opened a new pull request, #13117:
URL: https://github.com/apache/druid/pull/13117
Having HTML tags in docs is tricky business markdown is in general a bit overloaded as a concept.
What makes it ok to write `<br>` to mean the tag and also to write `<n>` to mean the number? How is the compiler to know what you want?
I went through the docs and scanned them with an [mdx](https://mdxjs.com/) parser that detects issues like these. I want to make this part of an automated check, but for now I want to merge this PR that fixes real bugs in the docs currently.
Most of the changes I made here show up in the docs as actual rendering bugs:
<img width="1078" alt="image" src="https://user-images.githubusercontent.com/177816/190934548-2d588e6e-2bb2-4e41-adcf-c9a502485397.png">
Usually text that is meant as user visible text gets treated as an html tag.
I want to share this tip with anyone writing docs in markdown:
Say you want to talk about something that is written in `<` and `>` like `Promise<void>` and have it render correctly. You can either put in in backticks (``` ` ```) to make it ca code block - but if you do it make sure that text in backticks is all on one line or you can escape the `>` to make it not a tag, so write it as `Promise<void\>` in the markdown (escaping the `<` does not do anything useful). Don't do both!
--
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.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
[GitHub] [druid] vogievetsky merged pull request #13117: fix html tags in docs
Posted by GitBox <gi...@apache.org>.
vogievetsky merged PR #13117:
URL: https://github.com/apache/druid/pull/13117
--
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.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org