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.

Sign up for GitHub

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

Jump to bottom

Docs: Drop inline callouts #38335

Closed
nik9000 opened this issue Feb 4, 2019 · 9 comments
Closed

Docs: Drop inline callouts #38335

nik9000 opened this issue Feb 4, 2019 · 9 comments
Assignees
@nik9000
Labels
>docs General docs changes

Comments

@nik9000
Copy link
Member

nik9000 commented Feb 4, 2019

We've not going to support inline callouts in asciidoctor. We're going to need to drop all of them from all branches of our docs before we can build them with asciidoctor. We use them fairly frequently in the SQL docs but they are rare otherwise.
@nik9000 nik9000 added the >docs General docs changes label Feb 4, 2019
@nik9000
Copy link
Member Author

nik9000 commented Feb 4, 2019

Inline callouts look like this:

----
POST <1> /_search/scroll <2>
----
<1> words
<2> other words

In asciidoctor all callouts have to be at the end of the line.

@nik9000
Copy link
Member Author

nik9000 commented Feb 4, 2019

Right now we don't have an enforcement mechanism to make sure that we can build the docs with asciidoctor. It wouldn't pass anyway because of a couple of this and one other strange failure in the reference docs. We also can't current run asciidoctor in CI, but I'm working on that too.

@nik9000 nik9000 self-assigned this Feb 4, 2019
nik9000 added a commit to nik9000/elasticsearch that referenced this issue Feb 4, 2019
@nik9000
Docs: Drop inline callout from scroll example
f4acd24 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to elastic#38335
@nik9000 nik9000 mentioned this issue Feb 4, 2019
Merged
nik9000 added a commit that referenced this issue Feb 4, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340)
5d949dd 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
nik9000 added a commit to nik9000/elasticsearch that referenced this issue Feb 4, 2019
@nik9000
Docs: Drop inline callout from scroll example (elastic#38340)
db26759 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to elastic#38335
@nik9000 nik9000 mentioned this issue Feb 4, 2019
Merged
nik9000 added a commit to nik9000/elasticsearch that referenced this issue Feb 4, 2019
@nik9000
Docs: Drop inline callout from scroll example (elastic#38340)
ecd06da 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to elastic#38335
@nik9000 nik9000 mentioned this issue Feb 4, 2019
Merged
nik9000 added a commit to nik9000/elasticsearch that referenced this issue Feb 4, 2019
@nik9000
Docs: Drop inline callout from scroll example (elastic#38340)
15daf84 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to elastic#38335
nik9000 added a commit that referenced this issue Feb 4, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340) (#38364)
1ff3a96 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
@nik9000 nik9000 mentioned this issue Feb 4, 2019
Merged
nik9000 added a commit to nik9000/elasticsearch that referenced this issue Feb 4, 2019
@nik9000
Docs: Drop inline callout from scroll example (elastic#38340)
7e7a683 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to elastic#38335
@nik9000 nik9000 mentioned this issue Feb 4, 2019
Merged
nik9000 added a commit to nik9000/elasticsearch that referenced this issue Feb 4, 2019
@nik9000
Docs: Drop inline callout from scroll example (elastic#38340)
a2b41f4 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to elastic#38335
@nik9000 nik9000 mentioned this issue Feb 4, 2019
Merged
nik9000 added a commit that referenced this issue Feb 4, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340) (#38365)
70e3ce5 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
nik9000 added a commit that referenced this issue Feb 4, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340) (#38366)
c8ce7b7 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
nik9000 added a commit that referenced this issue Feb 4, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340) (#38367)
1234a10 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
nik9000 added a commit to nik9000/elasticsearch that referenced this issue Feb 4, 2019
@nik9000
Docs: Drop inline callout from scroll example (elastic#38340)
3539d4a 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to elastic#38335
@nik9000 nik9000 mentioned this issue Feb 4, 2019
Merged
@colings86 colings86 added the :Docs label Feb 5, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs

@costin
Copy link
Member

costin commented Feb 5, 2019

I'm pretty sure in my use of Asciidoctor (years ago) call-outs were supported. A quick search of their docs seems to confirm this:

https://asciidoctor.org/docs/user-manual/#callouts
https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#source-code

Maybe it's the inline callouts that are problematic but end-of-line ones are fine?

This was referenced Feb 12, 2019
Merged
Merged
nik9000 added a commit to nik9000/elasticsearch that referenced this issue Feb 12, 2019
@nik9000
Docs: Drop inline callout from scroll example (elastic#38340)
8a1fab6 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to elastic#38335
@nik9000 nik9000 mentioned this issue Feb 12, 2019
Merged
nik9000 added a commit to nik9000/elasticsearch that referenced this issue Feb 12, 2019
@nik9000
Docs: Drop inline callout from scroll example (elastic#38340)
ac56486 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to elastic#38335
@nik9000 nik9000 mentioned this issue Feb 12, 2019
Closed
nik9000 added a commit to nik9000/elasticsearch that referenced this issue Feb 12, 2019
@nik9000
Docs: Drop inline callout from scroll example (elastic#38340)
1aaaea4 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to elastic#38335
@nik9000 nik9000 mentioned this issue Feb 12, 2019
Closed
nik9000 added a commit that referenced this issue Feb 12, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340) (#38804)
632d94a 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
nik9000 added a commit that referenced this issue Feb 12, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340) (#38806)
030bcab 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
nik9000 added a commit that referenced this issue Feb 12, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340) (#38809)
f8e357a 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
nik9000 added a commit to nik9000/elasticsearch that referenced this issue Feb 13, 2019
@nik9000
Docs: Drop inline callout from scroll example (elastic#38340)
1d1b5e9 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to elastic#38335
nik9000 added a commit that referenced this issue Feb 13, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340)
3a12337 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
nik9000 added a commit that referenced this issue Feb 13, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340)
e7d3e5f 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
nik9000 added a commit that referenced this issue Feb 13, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340)
c27cff9 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
nik9000 added a commit that referenced this issue Feb 13, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340)
ae93d5b 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
nik9000 added a commit that referenced this issue Feb 13, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340)
02d059b 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
nik9000 added a commit that referenced this issue Feb 13, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340)
0986d38 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
nik9000 added a commit that referenced this issue Feb 13, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340)
e080edc 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
nik9000 added a commit that referenced this issue Feb 13, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340)
b7f7618 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
nik9000 added a commit that referenced this issue Feb 13, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340)
ce11d05 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
nik9000 added a commit that referenced this issue Feb 13, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340)
b002ef7 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
nik9000 added a commit that referenced this issue Feb 13, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340)
cccafc7 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
nik9000 added a commit that referenced this issue Feb 13, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340)
fa22236 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
nik9000 added a commit that referenced this issue Feb 13, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340)
b7c1f62 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
nik9000 added a commit that referenced this issue Feb 13, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340)
7592cbd 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
nik9000 added a commit that referenced this issue Feb 13, 2019
@nik9000
Docs: Drop inline callout from scroll example (#38340)
60c54f8 
Coalesces two calls into one in a scroll example so all callouts are at
the end of the line. This is the only sort of callouts that are
supported by asciidoctor and we'd like to start building our docs with
asciidoctor.

At present we don't have any mechanism to stop folks adding more inline
callouts but we ought to be able to have one in a few weeks. For now,
though, removing these inline callouts is a step in the right direction.

Relates to #38335
@nik9000 nik9000 mentioned this issue Feb 21, 2019
Closed
@nik9000
Copy link
Member Author

nik9000 commented Apr 12, 2019

Eclipsed by #41128

@nik9000 nik9000 closed this as completed Apr 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nik9000 nik9000

Labels
>docs General docs changes
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@costin @nik9000 @colings86 @elasticmachine