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

Switches Kibana doc build to asciidoctor #756

Merged
merged 6 commits into from
Oct 15, 2019

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Mar 27, 2019

This PR switches the Kibana Reference to use asciidoctor.

It depends on fixes being backported in the kibana repo first: elastic/kibana#34002

conf.yaml Outdated Show resolved Hide resolved
@lcawl
Copy link
Contributor Author

lcawl commented Mar 27, 2019

I can build all the branches successfully now.
However, I think this book will also be affected by #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

@nik9000
Copy link
Member

nik9000 commented Mar 27, 2019 via email

@nik9000
Copy link
Member

nik9000 commented Mar 28, 2019

It looks like the 6.2 kibana docs don't build either:

INFO:build_docs:/tmp/docsbuild/target_repo/html/en/kibana/6.2/index.x.xml:8856: element listitem: validity error : Element listitem content does not follow the DTD, expecting (calloutlist | glosslist | bibliolist | itemizedlist | orderedlist | segmentedlist | simplelist | variablelist | caution | important | note | tip | warning | literallayout | programlisting | programlistingco | screen | screenco | screenshot | synopsis | cmdsynopsis | funcsynopsis | classsynopsis | fieldsynopsis | constructorsynopsis | destructorsynopsis | methodsynopsis | formalpara | para | simpara | address | blockquote | graphic | graphicco | mediaobject | mediaobjectco | informalequation | informalexample | informalfigure | informaltable | equation | example | figure | table | msgset | procedure | sidebar | qandaset | task | anchor | bridgehead | remark | highlights | abstract | authorblurb | epigraph | indexterm | beginpage)+, got ()
INFO:build_docs:</listitem>

@lcawl
Copy link
Contributor Author

lcawl commented Mar 28, 2019

I've fixed the build errors that were occurring between 6.2 and 5.3. Thanks @nik9000 !

@lcawl
Copy link
Contributor Author

lcawl commented Mar 28, 2019

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:

image

I created an issue for this: #760

@nik9000
Copy link
Member

nik9000 commented Apr 22, 2019

I believe this is now blocked on #824

@lcawl
Copy link
Contributor Author

lcawl commented May 2, 2019

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!

@nik9000
Copy link
Member

nik9000 commented May 6, 2019

Regenerating!

@nik9000
Copy link
Member

nik9000 commented May 6, 2019

It looks like I can't do it where I am now. I'll check again when I get home.

Copy link
Member

@nik9000 nik9000 left a 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.

@nik9000
Copy link
Member

nik9000 commented Aug 17, 2019

Now waiting on elastic/kibana#43473

@nik9000
Copy link
Member

nik9000 commented Aug 22, 2019

@elasticmachine, run elasticsearch-ci/docs

@nik9000
Copy link
Member

nik9000 commented Aug 22, 2019

@KOTungseth, I've kicked off another build of this PR. It should tell us if elastic/kibana#43473 was enough to get asciidoctor working!

@nik9000 nik9000 removed the WIP label Aug 22, 2019
@nik9000
Copy link
Member

nik9000 commented Aug 22, 2019

A bunch of files change:

@nik9000
Copy link
Member

nik9000 commented Aug 22, 2019

I'll track these down!

@nik9000
Copy link
Member

nik9000 commented Aug 22, 2019

Adds html/en/kibana/3.0/_configuration.html

This one seems like a net positive.

@nik9000
Copy link
Member

nik9000 commented Aug 22, 2019

* Adds html/en/kibana/3.0/_configuration.html

This page was getting rolled into the previous page. Asciidoctor actually fixes this!

@nik9000 nik9000 mentioned this pull request Aug 28, 2019
@nik9000
Copy link
Member

nik9000 commented Aug 28, 2019

@elasticmachine, run elasticsearch-ci/docs

@nik9000
Copy link
Member

nik9000 commented Aug 30, 2019

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

@nik9000
Copy link
Member

nik9000 commented Oct 10, 2019

I opened elastic/kibana#47876

@nik9000
Copy link
Member

nik9000 commented Oct 10, 2019

run elasticsearch-ci/docs

@nik9000
Copy link
Member

nik9000 commented Oct 11, 2019

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.

@nik9000
Copy link
Member

nik9000 commented Oct 11, 2019

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.

@nik9000
Copy link
Member

nik9000 commented Oct 11, 2019

I opened elastic/kibana#48018 to fix a bad render in Asciidoctor.

@lcawl lcawl merged commit 1ed11de into elastic:master Oct 15, 2019
@lcawl lcawl deleted the kibana-asciidoctor branch October 15, 2019 22:23
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