-
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
Switches Kibana doc build to asciidoctor #756
Conversation
I can build all the branches successfully now. For example, this page has broken inline images when it's built with asciidoctor: |
Awe! Well I'm closer to getting that merged so that is good.
…On Wed, Mar 27, 2019, 18:24 Lisa Cawley ***@***.***> wrote:
I can build all the branches successfully now.
However, I think this book will also be affected by #730
<#730>
For example, this page has broken inline images when it's built with
asciidoctor:
https://www.elastic.co/guide/en/kibana/master/_bar_chart.html
[image: image]
<https://user-images.githubusercontent.com/26471269/55116328-22c97f00-50a4-11e9-964b-9d62687d2b46.png>
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#756 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AANLotO_W3ev4oCrXV_kFiBVrQ_FipvEks5va--igaJpZM4cOjY6>
.
|
It looks like the 6.2 kibana docs don't build either:
|
I've fixed the build errors that were occurring between 6.2 and 5.3. Thanks @nik9000 ! |
I noticed a new error too. When pages contain abbreviated titles with attributes in them, the attributes are resolved in the page but not in the table of contents. For example in 6.1: I created an issue for this: #760 |
I believe this is now blocked on #824 |
I've rebased these files and they build cleanly. I think we should re-generate the diffs--I think we're close to being finished with this one! |
Regenerating! |
It looks like I can't do it where I am now. I'll check again when I get home. |
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've merged master into this PR to get it up to date and to cause it to build a preview.
Now waiting on elastic/kibana#43473 |
@elasticmachine, run elasticsearch-ci/docs |
@KOTungseth, I've kicked off another build of this PR. It should tell us if elastic/kibana#43473 was enough to get asciidoctor working! |
A bunch of files change:
|
I'll track these down! |
This one seems like a net positive. |
This page was getting rolled into the previous page. Asciidoctor actually fixes this! |
@elasticmachine, run elasticsearch-ci/docs |
OK! I think we're ready to look at the actual diff! I've merged master into this branch to trigger a fresh build so we can use that for the diff. I don't know when I'll have time to look at it though..... |
I opened elastic/kibana#47876 |
run elasticsearch-ci/docs |
I built a diff against the master branch and there were not significant changes. Really the diff was a net positive because there were a few sections that didn't render well with Asciidoc. There were a few different inline IDs but I don't think they are a big deal. I'll check the 7 and 6 branches next. So far, everything looks really good. |
Here is a list of things I think are worth fixing in Kibana that come up with asciidoctor. I believe there are two of them affect master. One of them looks to have been a bug for a long, long time. So I think it'd be fine to do the switch and then retroactively fix the issues. |
I opened elastic/kibana#48018 to fix a bad render in Asciidoctor. |
This PR switches the Kibana Reference to use asciidoctor.
It depends on fixes being backported in the kibana repo first: elastic/kibana#34002