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

[DOCS] Remove inline callouts in SQL Command docs for Asciidoctor migration #41276

Merged
merged 2 commits into from
Apr 22, 2019
Merged

[DOCS] Remove inline callouts in SQL Command docs for Asciidoctor migration #41276

merged 2 commits into from
Apr 22, 2019

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Apr 16, 2019

Removes inline callouts from the SQL Commands documentation. This change helps prepare Elasticsearch docs for Asciidoctor migration.

Per https://asciidoctor.org/docs/user-manual/#callouts, AsciiDoctor enforces this requirement: "The callout number (at the target) must be placed at the end of the line."

Relates to #41128

Before / After Rendering

DESCRIBE TABLE

Before
describe-before

After
Screen Shot 2019-04-17 at 6 29 15 AM

SHOW COLUMNS

Before
show-columns-before

After
Screen Shot 2019-04-17 at 6 29 52 AM

SHOW FUNCTIONS

Before
show-functions-before

After
Screen Shot 2019-04-17 at 6 37 20 AM

SHOW TABLES

Before
show-tables-before

After
Screen Shot 2019-04-17 at 6 31 28 AM

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-search

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@nik9000 nik9000 left a comment

Choose a reason for hiding this comment

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

LGTM2

DESCRIBE [table identifier<1> | [LIKE pattern<2>]]
DESCRIBE
[table identifier | <1>
[LIKE pattern]] <2>
Copy link
Member

Choose a reason for hiding this comment

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

I'd probably vertically align these but it isn't a big deal either way.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the suggestion @nik9000! I aligned the callouts in c9b9aa6. Also updated the before/after images above.

@nik9000
Copy link
Member

nik9000 commented Apr 17, 2019

Thanks! Still LGTM.

@costin
Copy link
Member

costin commented Apr 18, 2019

LGTM

Copy link
Member

@costin costin left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@costin costin left a comment

Choose a reason for hiding this comment

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

LGTM

@jrodewig jrodewig merged commit d042f26 into elastic:master Apr 22, 2019
@jrodewig jrodewig deleted the fix-asciidoctor-errors-sql-commands branch April 22, 2019 13:22
gurkankaymak pushed a commit to gurkankaymak/elasticsearch that referenced this pull request May 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants