-
Notifications
You must be signed in to change notification settings - Fork 338
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
Add support for switching books to asciidoctor #606
Conversation
Adds support for switching individual books to Asciidoctor in `conf.yaml`. It then cuts the glossary over to Asciidoctor. This is what the changed docs look like: https://github.com/elastic/built-docs-nik/commit/dfafa93c3c483bf74c2091f832c916f1ccc842ba There are some line break changes which we can ignore. There is a change to the HTML - in a `<dd>` AsciiDoc added a `<p class="simpara">` tag. Asciidoctor does not. The rendered result looks ever so slightly better to me so I'm personally fine with it. The font size is `15px` instead of `16px` and the weight is `400` instead of `normal`.
I can merge this once it gets approval from @ddillinger (perl code) and @lcawl (different rendering). That would force a fairly important change: CI is perfectly fine with this as it is running docker 100% of the time now. But folks build this locally and they'll need to be comfortable with it. The thing that jumps out at me is that |
❤️ @ddillinger! |
Ooh! I just realized I should update |
The asciidoctor version of the Glossary LGTM. Very exciting! With respect to the need to use docker for --all, I suspect that it's not too common for folks to run the full build very often (particularly since it has historically taken so long). But I agree it's a good idea to double-check before we force their hand. |
@@ -81,6 +81,7 @@ contents: | |||
branches: [ master ] | |||
tags: Elastic Stack/Glossary | |||
subject: Elastic Stack | |||
asciidoctor: true |
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.
One thought: Should/could this be a list of versions (akin to "branches") instead of a boolean? If so, it would give us more wiggle room if we can't convert some of the very old releases to asciidoctor builds.
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.
I'd be happy to do that when we figure out that we need it.
Adds support for switching individual books to Asciidoctor in `conf.yaml`. It then cuts the glossary over to Asciidoctor. This is what the changed docs look like: https://github.com/elastic/built-docs-nik/commit/dfafa93c3c483bf74c2091f832c916f1ccc842ba There are some line break changes which we can ignore. There is a change to the HTML - in a `<dd>` AsciiDoc added a `<p class="simpara">` tag. Asciidoctor does not. The rendered result looks ever so slightly better to me so I'm personally fine with it. The font size is `15px` instead of `16px` and the weight is `400` instead of `normal`.
Adds support for switching individual books to Asciidoctor in
conf.yaml
.It then cuts the glossary over to Asciidoctor. This is what the changed
docs look like:
https://github.com/elastic/built-docs-nik/commit/dfafa93c3c483bf74c2091f832c916f1ccc842ba
There are some line break changes which we can ignore. There is a change
to the HTML - in a
<dd>
AsciiDoc added a<p class="simpara">
tag.Asciidoctor does not. The rendered result looks ever so slightly better
to me so I'm personally fine with it. The font size is
15px
instead of16px
and the weight is400
instead ofnormal
.