-
Notifications
You must be signed in to change notification settings - Fork 337
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
Switch the ECS docs to Asciidoctor #813
Conversation
Switches the core of the docs build for the ECS docs from the unmaintained AsciiDoc project to the actively developed Asciidoctor project.
Needs elastic/ecs#430 to be merged and backported to the 1.0 branch before I can make a diff. |
@webmat, this is what merging the PR would do the generated docs. If you are ok ecs-faq.html: - AsciiDoc
+ Asciidoctor
@@ -739,10 +739,10 @@
is identical to ingesting the following JSON:
</p>
<div class="pre_wrapper">
- <pre class="programlisting prettyprint lang-json">"user": {
- "firstname": "Nicolas",
- "lastname": "Ruflin"
-}</pre>
+ <pre class="programlisting prettyprint lang-json"> "user": {
+ "firstname": "Nicolas",
+ "lastname": "Ruflin"
+ }</pre>
</div>
<p>
In Elasticsearch, AsciiDoc seems to be eating the leading indentation. If don't mean to have it ecs-reference.html: - AsciiDoc
+ Asciidoctor
@@ -621,7 +621,7 @@
</ul>
</div>
<h3>
- <a id="_my_events_don_8217_t_map_with_ecs">
+ <a id="_my_events_dont_map_with_ecs">
</a>
My events don’t map with ECS
<a class="edit_me" href="https://github.com/elastic/ecs/edit/1.0/docs/index.asciidoc" rel="nofollow" title="Edit this page on GitHub"> These happen because you aren't explicit about your section titles. AsciiDoc's |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome! LGTM
Thanks for reviewing @karenzone! |
Awesome! I guess I'll go update the make targets in the ECS repo now 🏃 😂 |
Switches the core of the docs build for the ECS docs from the
unmaintained AsciiDoc project to the actively developed Asciidoctor
project.