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 X-Pack Reference to Asciidoctor builds #653

Merged
merged 4 commits into from
May 3, 2019

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Feb 27, 2019

This PR updates the X-Pack Reference (https://www.elastic.co/guide/en/x-pack/index.html) such that it's built via Asciidoctor.

Related to #606

@lcawl lcawl added the WIP label Feb 27, 2019
@lcawl lcawl mentioned this pull request Feb 27, 2019
@nik9000
Copy link
Member

nik9000 commented Mar 4, 2019

This one is currently not building with:

INFO:build_docs:/tmp/docsbuild/target_repo/html/en/x-pack/6.2/index.xml:445: element partintro: validity error : Element partintro content does not follow the DTD, expecting ((title , subtitle? , titleabbrev?)? , (((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)+ , (sect1* | refentry* | simplesect* | section*)) | sect1+ | refentry+ | simplesect+ | section+)), got (titleabbrev )

Looks like some kind of bug. Not sure what though.

@lcawl
Copy link
Contributor Author

lcawl commented Mar 4, 2019

@nik9000 Is that after fixing the issue with the path to the elasticsearch-extra folder per #505 (comment) ? Those are the errors I'm seeing with --lenient

@nik9000
Copy link
Member

nik9000 commented Mar 4, 2019

I was getting that error with --all rather than the --doc version. I've still got fixing --doc for this book on my list....

@lcawl
Copy link
Contributor Author

lcawl commented Mar 4, 2019

I think it's the same error. I get a similar partintro error when I build the individual book without --lenient.

@lcawl
Copy link
Contributor Author

lcawl commented Mar 5, 2019

The aforementioned error was caused by a <titleabbrev> after all, per https://github.com/elastic/x-pack-elasticsearch/pull/4479

@lcawl
Copy link
Contributor Author

lcawl commented Mar 15, 2019

The documentation build errors seem to be solved by #721

@nik9000
Copy link
Member

nik9000 commented Apr 17, 2019

This seems to fail to build in the 5.6 branch.

@nik9000
Copy link
Member

nik9000 commented Apr 24, 2019

This one is now blocked on #824.

@nik9000
Copy link
Member

nik9000 commented May 3, 2019

I'm regenerating the diff for this one now.

@nik9000
Copy link
Member

nik9000 commented May 3, 2019

The differences seem to amount to:

  1. Some different ids (bad but not a big deal in legacy docs)
  2. A few ordered lists being reset when they shouldn't be (bad but not a huge deal in legacy docs)
  3. A few ordered lists not being reset when they shouldn't be being reset but they were (good)
  4. Table headings moving from the tbody into thead (good)
  5. Lines with missing variables appearing when they were previously gone (good)
  6. Some indentation changes around admonishments inside of callouts. (meh)

At this point switching to Asciidoctor is a net positive on the results so I think we should merge this. I don't think any of the problems are worth going back and fixing at this point. But that is just my opinion.

@nik9000 nik9000 removed the WIP label May 3, 2019
@nik9000
Copy link
Member

nik9000 commented May 3, 2019

@lcawl, I'm going to leave the merging this to you. If you agree with my reasoning then merge when ready1

@lcawl lcawl merged commit 013ce35 into elastic:master May 3, 2019
@lcawl lcawl deleted the xpack-asciidoctor branch May 3, 2019 15:36
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