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

Some docs optimization #6890

Merged
merged 2 commits into from
Apr 13, 2019
Merged

Conversation

zhaojiandong
Copy link
Contributor

@zhaojiandong zhaojiandong commented Jan 20, 2019

Some docs optimization

@zhaojiandong zhaojiandong changed the title Squashed commit of the following: Some docs optimization Jan 20, 2019
@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe github hasn't supported markdown="1" :

<div markdown="1">
    #Heading 1
</div>

It's not work @gianm

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I guess inside HTML, markdown isn't respected? I didn't realize that.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess so~

@@ -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 &#124;&#124; y`|Concat strings x and y.|
Copy link
Contributor

@jon-wei jon-wei Jan 30, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After playing around a bit I found something that works:

|<code>x &#124;&#124; y</code>|Concat strings x and y.|

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It works! 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fjy fjy added this to the 0.15.0 milestone Mar 11, 2019
@jon-wei jon-wei merged commit 1d9450d into apache:master Apr 13, 2019
clintropolis pushed a commit that referenced this pull request Apr 24, 2019
* some markdown docs optimization

* markdown escape
@clintropolis clintropolis modified the milestones: 0.15.0, 0.14.1 Apr 24, 2019
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.

6 participants