Skip to content

Some docs optimization#6890

Merged
jon-wei merged 2 commits intoapache:masterfrom
zhaojiandong:bufixes/doc_optimization
Apr 13, 2019
Merged

Some docs optimization#6890
jon-wei merged 2 commits intoapache:masterfrom
zhaojiandong:bufixes/doc_optimization

Conversation

@zhaojiandong
Copy link
Copy Markdown
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
@zhaojiandong zhaojiandong force-pushed the bufixes/doc_optimization branch from f9c618d to 680a179 Compare January 20, 2019 15:30
Comment thread docs/content/operations/metrics.md Outdated
Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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~

Comment thread docs/content/querying/sql.md Outdated
Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@zhaojiandong zhaojiandong force-pushed the bufixes/doc_optimization branch from 1d100a5 to 57d95fe Compare February 14, 2019 12:33
@zhaojiandong zhaojiandong force-pushed the bufixes/doc_optimization branch from 57d95fe to 19d6d3e Compare February 21, 2019 12:30
@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