Some docs optimization #6890
Some docs optimization #6890
Conversation
zhaojiandong
changed the title
zhaojiandong
force-pushed
the
bufixes/doc_optimization
branch
from
f9c618d to
680a179
Compare
| @@ -526,8 +526,8 @@ druid.query.segmentMetadata.defaultHistory | |||
| Returns the dimensions of the datasource. | |||
|
|
|||
| <div class="note caution"> | |||
| This API is deprecated and will be removed in future releases. Please use [SegmentMetadataQuery](../querying/segmentmetadataquery.html) instead | |||
| which provides more comprehensive information and supports all dataSource types including streaming dataSources. It's also encouraged to use [INFORMATION_SCHEMA tables](../querying/sql.html#retrieving-metadata) | |||
| This API is deprecated and will be removed in future releases. Please use <a href="/querying/segmentmetadataquery.html">SegmentMetadataQuery</a> instead | |||
There was a problem hiding this comment.
The [text](url) syntax should work fine and is standard for Markdown. Was something not working with it? (I notice one of the links had a link break between [SegmentMetadataQuery] and (../querying/segmentmetadataquery.html), that one probably needed to be connected.
There was a problem hiding this comment.
Maybe github hasn't supported markdown="1" :
<div markdown="1">
#Heading 1
</div>
It's not work @gianm
There was a problem hiding this comment.
Oh, I guess inside HTML, markdown isn't respected? I didn't realize that.
docs/content/querying/sql.md
Outdated
| @@ -149,7 +149,7 @@ String functions accept strings, and return a type appropriate to the function. | |||
|
|
|||
| |Function|Notes| | |||
| |--------|-----| | |||
| |`x \|\| y`|Concat strings x and y.| | |||
| |`x || y`|Concat strings x and y.| | |||
There was a problem hiding this comment.
Hm, I don't think this encoding is working: https://github.com/apache/incubator-druid/blob/1d100a54f70c00729f0b33d32ae6a2a042b48cb7/docs/content/querying/sql.md
There was a problem hiding this comment.
After playing around a bit I found something that works:
|<code>x || y</code>|Concat strings x and y.|
There was a problem hiding this comment.
zhaojiandong
force-pushed
the
bufixes/doc_optimization
branch
from
1d100a5 to
57d95fe
Compare
zhaojiandong
force-pushed
the
bufixes/doc_optimization
branch
from
57d95fe to
19d6d3e
Compare
* some markdown docs optimization * markdown escape
Some docs optimization