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.

Sign up for GitHub

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

Jump to bottom

Build documentation directly to HTML; eliminate DocBook step #743

Closed
lcawl opened this issue Mar 21, 2019 · 2 comments
Closed

Build documentation directly to HTML; eliminate DocBook step #743

lcawl opened this issue Mar 21, 2019 · 2 comments
Assignees
@nik9000
Labels
enhancement Something we'd like to improve

Comments

@lcawl
Copy link
Contributor

lcawl commented Mar 21, 2019 •
edited by bmorelli25
Loading

After our migration to Asciidoctor is complete, there are features we cannot use due to the fact that we still convert to DocBook then HTML. The features don't seem to generate errors or warnings, they just don't work. For example:

Per #249 (comment) "Docbook output is required as the asciidoctor html output doesn't support html chunking, plus docbook gives us strict link checking. It would still be a big speedup. That said, I don't know about the difference in output and error checking behaviour. Plus the customizations need to be ported over. This is a huge undertaking..."

This issue is intended to collect a list of the features that don't work in the current implementation and ideas about how we could eliminate the need for Docbook.
@lcawl lcawl added enhancement Something we'd like to improve team-discuss labels Mar 21, 2019
@nik9000 nik9000 self-assigned this Nov 5, 2019
@nik9000
Copy link
Member

nik9000 commented Nov 5, 2019

I'm going to pick this up soon!

nik9000 added a commit to nik9000/docs that referenced this issue Nov 8, 2019
@nik9000
Add the option to skip docbook for single page
ed99dbe 
This adds the option to generate html directly from asciidoctor for
single page books with `--direct_html`. Right now no books use this but
we'd like to migrate all of them too it once we're sure the output looks
good for them!

Relates to elastic#743
@nik9000 nik9000 mentioned this issue Nov 8, 2019
Merged
nik9000 added a commit that referenced this issue Nov 8, 2019
@nik9000
Add the option to skip docbook for single page (#1391)
4439415 
This adds the option to generate html directly from asciidoctor for
single page books with `--direct_html`. Right now no books use this but
we'd like to migrate all of them too it once we're sure the output looks
good for them!

Relates to #743
@nik9000
Copy link
Member

nik9000 commented Apr 8, 2020

I think we've actually finish this. I removed docbook from the docs repo entirely in January.

@nik9000 nik9000 closed this as completed Apr 8, 2020
@debadair debadair mentioned this issue Apr 30, 2020
Closed
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nik9000 nik9000

Labels
enhancement Something we'd like to improve
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@nik9000 @lcawl