Skip to content

Switch APM Overview to Asciidoctor - #733

Merged
nik9000 merged 2 commits into
elastic:masterfrom
nik9000:asciidoctor_apm_guide
Mar 20, 2019
Merged

Switch APM Overview to Asciidoctor#733
nik9000 merged 2 commits into
elastic:masterfrom
nik9000:asciidoctor_apm_guide

Conversation

@nik9000

@nik9000 nik9000 commented Mar 18, 2019

Copy link
Copy Markdown
Member

Switches the core of the docs build for the APM overview from the
unmaintained AsciiDoc to the actively maintained AsciiDoctor project. It
is marginally faster to build as well. The HTML output is the same
modulo some spacing differences and one real change to the tables on the
install-and-run page. The first element on the table gets the
"heading" formatting. Like this:

-                <a class="ulink" href="https://www.elastic.co/guide/en/apm/agent/js-base/current/intro.html" target="_top">
-                 Introduction
-                </a>
+                <span class="strong strong">
+                 <strong>
+                  <a class="ulink" href="https://www.elastic.co/guide/en/apm/agent/js-base/current/intro.html" target="_top">
+                   Introduction
+                  </a>
+                 </strong>
+                </span>

This is worth looking into. It isn't what we want but I can see why
Asciidoctor does it.

Switches the core of the docs build for the APM overview from the
unmaintained AsciiDoc to the actively maintained AsciiDoctor project. It
is marginally faster to build as well. The HTML output is the same
modulo some spacing differences and one real change to the tables on the
`install-and-run` page. The first element on the table gets the
"heading" formatting. Like this:
```
-                <a class="ulink" href="https://www.elastic.co/guide/en/apm/agent/js-base/current/intro.html" target="_top">
-                 Introduction
-                </a>
+                <span class="strong strong">
+                 <strong>
+                  <a class="ulink" href="https://www.elastic.co/guide/en/apm/agent/js-base/current/intro.html" target="_top">
+                   Introduction
+                  </a>
+                 </strong>
+                </span>
```

This is worth looking into. It isn't what we want but I can see *why*
Asciidoctor does it.
@nik9000
nik9000 requested a review from bmorelli25 March 18, 2019 17:06
@nik9000 nik9000 mentioned this pull request Mar 18, 2019
@bmorelli25

Copy link
Copy Markdown
Member

Ohh, actually, this is perfect! I added attributes that should add a header to that table: https://github.com/elastic/apm-server/blame/master/docs/guide/install-and-run.asciidoc#L99
If you remove the "h" and re-run the build, the strong strong goes away.

@bmorelli25 bmorelli25 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Got asciidoc on the mind?

Comment thread doc_build_aliases.sh Outdated
Co-Authored-By: nik9000 <nik9000@gmail.com>
@nik9000

nik9000 commented Mar 20, 2019

Copy link
Copy Markdown
Member Author

strong strong

Strong strong!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants