Skip to content

Drop inline callouts from docs #1262

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

Closed
nik9000 opened this issue Mar 12, 2019 · 0 comments
Closed

Drop inline callouts from docs #1262

nik9000 opened this issue Mar 12, 2019 · 0 comments
Labels

Comments

@nik9000
Copy link
Member

nik9000 commented Mar 12, 2019

We're working to switch the core of the docs build tools from the no-longer-maintained AsciiDoc to the actively-maintained Asciidoctor. For the most part Asciidoctor is compatible with AsciiDoc or we've made it compatible with extensions. But in one case we've decided not to make it compatible because it is both difficult and doesn't make the docs a lot better. It does require that we change a bunch of asciidoc files, sadly. In particular, we need to drop "inline callouts". An example from elasticsearch-hadoop:

.Map/Reduce
["source","xml",subs="attributes"]
----
<dependency>
  <groupId>org.elasticsearch</groupId>
  <artifactId>elasticsearch-hadoop-mr<1></artifactId>
  <version>{ver}</version>
</dependency>
----

<1> 'mr' artifact

It can be made to be supported with:

.Map/Reduce
["source","xml",subs="attributes"]
----
<dependency>
  <groupId>org.elasticsearch</groupId>
  <artifactId>elasticsearch-hadoop-mr</artifactId> <1>
  <version>{ver}</version>
</dependency>
----

<1> 'mr' artifact
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant