Switch es-hadoop docs to asciidoctor #785
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Switches the ES-hadoop based docs from the unmaintained AsciiDoc backend to the actively maintained Asciidoctor backend. This makes them 3x faster to build.
|
This need elastic/elasticsearch-hadoop#1270 to be merged and backported "all the way". |
Closed
|
Here is my hand compiled html diff for this one: storm.html: -AsciiDoc
+Asciidoctor
@@ -1682,7 +1682,7 @@
</div>
</div>
<h5>
- <a id="_customizing_literal_esspout_literal_fields">
+ <a id="_customizing_esspout_fields">
</a>
Customizing
<code class="literal">We could pin this this and the ones like it but I don't think it is worth it. breaking-changes.html: -AsciiDoc
+Asciidoctor
@@ -964,7 +964,7 @@
<div>
<div>
<h4 class="title">
- <a id="_version_literal_light_literal_removed">
+ <a id="_version_light_removed">
</a>
Version
<code class="literal">Same. There are a bunch of these so I won't keep repeating them. yarn-requirements.html: -AsciiDoc
+Asciidoctor
@@ -643,19 +643,17 @@
<col class="col_1"/>
<col class="col_2"/>
</colgroup>
+ <thead>
+ <tr>
+ <th align="left" valign="top">
+ Distribution
+ </th>
+ <th align="left" valign="top">
+ Release
+ </th>
+ </tr>
+ </thead>
<tbody>
- <tr>
- <td align="left" valign="top">
- <p>
- Distribution
- </p>
- </td>
- <td align="left" valign="top">
- <p>
- Release
- </p>
- </td>
- </tr>
<tr>
<td align="left" valign="top">
<p>This seems better actually. float.html: -AsciiDoc
+Asciidoctor
@@ -576,7 +576,15 @@
</div>
</div>
<p>
- Elasticsearch for Apache Hadoop is an ‘umbrella’ project consisting of three similar, yet independent sub-projects with their own, dedicated, section in the documentation:
+ Elasticsearch for Apache Hadoop is an
+ <span class="quote">
+ “
+ <span class="quote">
+ umbrella
+ </span>
+ ”
+ </span>
+ project consisting of three similar, yet independent sub-projects with their own, dedicated, section in the documentation:
</p>
<div class="variablelist">
<dl class="variablelist">This seems ok. There are a few like it. spark.html: -AsciiDoc
+Asciidoctor
@@ -1873,20 +1873,14 @@
</h4>
<p>
Elasticsearch allows each document to have its own
- <a class="ulink" href="http://www.elasticsearch.org/guide/en/elasticsearch/guide/current/_document_metadata.html" target="_top">
+ <a class="ulink" href="http://www.elasticsearch.org/guide/en/elasticsearch/guide/current/_document\_metadata.html" target="_top">
metadata
</a>
. As explained above, through the various
<a class="link" href="configuration.html#cfg-mapping" title="Mapping (when writing to Elasticsearch)edit">
mapping
</a>
@@ -5161,20 +5155,14 @@
</h4>
<p>
Elasticsearch allows each document to have its own
- <a class="ulink" href="http://www.elasticsearch.org/guide/en/elasticsearch/guide/current/_document_metadata.html" target="_top">
+ <a class="ulink" href="http://www.elasticsearch.org/guide/en/elasticsearch/guide/current/_document\_metadata.html" target="_top">
metadata
</a>
. As explained above, through the various
<a class="link" href="configuration.html#cfg-mapping" title="Mapping (when writing to Elasticsearch)edit">
mapping
</a>The links 404s anyway..... spark.html: -AsciiDoc
+Asciidoctor
- options one can customize these parameters so that their values are extracted from their belonging document. Further more, one can even include/exclude what parts of the data are sent back to Elasticsearch. In Spark, elasticsearch-hadoop extends this functionality allowing metadata to be supplied
- <span class="emphasis">
- <em>
- outside
- </em>
- </span>
- the document itself through the use of
+ options one can customize these parameters so that their values are extracted from their belonging document. Further more, one can even include/exclude what parts of the data are sent back to Elasticsearch. In Spark, elasticsearch-hadoop extends this functionality allowing metadata to be supplied _outside_ the document itself through the use of
<a class="ulink" href="http://spark.apache.org/docs/latest/programming-guide.html#working-with-key-value-pairs" target="_top">
<span class="emphasis">
<em>This seems worth fixing. html/en/elasticsearch/hadoop/5.0/pig.html -AsciiDoc
+Asciidoctor
@@ -1263,7 +1271,7 @@
</p>
<div class="pre_wrapper">
<pre class="programlisting prettyprint lang-sql">STORE B INTO '...' USING org.elasticsearch.hadoop.pig.EsStorage(
- 'es.mapping.names=date:@timestamp, uRL:url') <a id="CO39-1"></a><span><img alt="" src="images/icons/callouts/1.png"/></span></pre>
+ 'es.mapping.names=date:@timestamp, uRL:url') <a id="CO39-1"></a><span><img alt="" src="images/icons/callouts/1.png"/></span></pre>
</div>
<div class="calloutlist">
<table border="0" summary="Callout list">There was a tab in the source. This keeps it which is probably ok. eshadoop-5.0.0.html: -AsciiDoc
+Asciidoctor
@@ -979,11 +979,7 @@
</a>
</li>
<li class="listitem">
- Invalid target URI
- <a class="ulink" href="mailto:POST@null" target="_top">
- POST@null
- </a>
- /pharmadata/test/_search
+ Invalid target URI POST@null/pharmadata/test/_search
<a class="ulink" href="http://github.com/elastic/elasticsearch-hadoop/issues/748" target="_top">
#748
</a>Since ey-usage.html: -AsciiDoc
+Asciidoctor
@@ -841,7 +841,9 @@
<p>
If you prefer the web ui, point your browser to the cluster console (typically on port 8088 -
<code class="literal">
- http://hadoop:8088/cluster
+ <a class="ulink" href="http://hadoop:8088/cluster" target="_top">
+ http://hadoop:8088/cluster
+ </a>
</code>
) and the newly created Elasticsearch cluster, or rather its
<code class="literal">This seems ok. Not, like, great, but i don't think it hurts anything.... configuration.html: -AsciiDoc
+Asciidocto
@@ -2706,17 +2706,19 @@
</span>
</dt>
<dd>
- Https proxy host name
- <span class="added">
- [
- <span class="version">
- 2.2
- </span>
- ]
- <span class="detail">
- Added in 2.2.
- </span>
- </span>
+ <p class="simpara">
+ Https proxy host name
+ </p>
+ <div class="note admon">
+ <div class="icon">
+ <img alt="Note" src="images/icons/note.png"/>
+ </div>
+ <div class="admon_content">
+ <p>
+ Added in 2.2.
+ </p>
+ </div>
+ </div>
</dd>
<dt>
<span class="term">
@@ -2726,17 +2728,19 @@
</span>
</dt>
<dd>
- Https proxy port
- <span class="added">
- [
- <span class="version">
- 2.2
- </span>
- ]
- <span class="detail">
- Added in 2.2.
- </span>
- </span>
+ <p class="simpara">
+ Https proxy port
+ </p>
+ <div class="note admon">
+ <div class="icon">
+ <img alt="Note" src="images/icons/note.png"/>
+ </div>
+ <div class="admon_content">
+ <p>
+ Added in 2.2.
+ </p>
+ </div>
+ </div>
</dd>
<dt>
<span class="term">
@@ -2746,17 +2750,19 @@
</span>
</dt>
<dd>
- Https proxy user name
- <span class="added">
- [
- <span class="version">
- 2.2
- </span>
- ]
- <span class="detail">
- Added in 2.2.
- </span>
- </span>
+ <p class="simpara">
+ Https proxy user name
+ </p>
+ <div class="note admon">
+ <div class="icon">
+ <img alt="Note" src="images/icons/note.png"/>
+ </div>
+ <div class="admon_content">
+ <p>
+ Added in 2.2.
+ </p>
+ </div>
+ </div>
</dd>
<dt>
<span class="term">
@@ -2766,17 +2772,19 @@
</span>
</dt>
<dd>
- Https proxy password
- <span class="added">
- [
- <span class="version">
- 2.2
- </span>
- ]
- <span class="detail">
- Added in 2.2.
- </span>
- </span>
+ <p class="simpara">
+ Https proxy password
+ </p>
+ <div class="note admon">
+ <div class="icon">
+ <img alt="Note" src="images/icons/note.png"/>
+ </div>
+ <div class="admon_content">
+ <p>
+ Added in 2.2.
+ </p>
+ </div>
+ </div>
</dd>
<dt>
<span class="term">I'll take a look at how this renders. eshadoop-6.4.3.html: -AsciiDoc
+Asciidoctor
@@ -616,7 +616,7 @@
Illegal unquoted character
<a class="indexterm" id="id-1.7.8.3.2.1.2.1.1.1.1">
</a>
- CTRL-CHAR: has to be escaped using backslash
+ CTRL-CHAR, code 9: has to be escaped using backslash
<a class="ulink" href="https://github.com/elastic/elasticsearch-hadoop/issues/1198" target="_top">
#1198
</a>This one is an improvement. |
|
I've opened elastic/elasticsearch-hadoop#1275 to clean up the conversion problems. Then we should be ready to go. |
|
I've merged and backported elastic/elasticsearch-hadoop#1275! So now we're ready to do the switch! |
Awesome! Let's do this! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Switches the ES-hadoop based docs from the unmaintained AsciiDoc backend
to the actively maintained Asciidoctor backend. This makes them 3x
faster to build.