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.

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 APM Overview to Asciidoctor #733

Merged
merged 2 commits into from
Mar 20, 2019

Conversation

nik9000
Copy link
Member

@nik9000 nik9000 commented Mar 18, 2019

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
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.

Copy link
Member

@bmorelli25 bmorelli25 left a comment

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?

doc_build_aliases.sh Outdated Show resolved Hide resolved
Co-Authored-By: nik9000 <nik9000@gmail.com>
@nik9000
Copy link
Member Author

nik9000 commented Mar 20, 2019

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