[teiid-issues] [JBoss JIRA] (TEIID-5822) Move off of gitbook

[Steven Hawkins (Jira)]

    [ https://issues.jboss.org/browse/TEIID-5822?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13803952#comment-13803952 ] 

Steven Hawkins commented on TEIID-5822:
---------------------------------------

The structure of the source will change a good bit.  We effectively have two books now - one for wildfly and one for spring.  However we are able to do this because of gitbook templating:  {code}{% if book.targetWildfly %}{code} - which is not directly supported nor do I see a similar templating mechanism for antora.  In looks like you could try to add a nunjunks processing stage to the build process to evaluate those blocks, but I'd rather not go down that path.

For a given book you create a site file that defines what is being built:
site.yml - composed of components (can be local or remote/git)

The components are composed of modules - at least a ROOT, possibly more.  Assuming an entire wildfly component:
wildfly/antora.yml
wildfly/modules/ROOT/nav.adoc
wildfly/modules/ROOT/assets
wildfly/modules/ROOT/pages/blah.adoc
wildfly/modules/ROOT/examples/foo.ddl
wildfly/modules/name/...

We can make each of the guides a module or each of the guides a component.  As a component we can pull each of them in individually into a the site file that defines the overall book - but we at least have to override the nav structure to do that.

> Move off of gitbook
> -------------------
>
>                 Key: TEIID-5822
>                 URL: https://issues.jboss.org/browse/TEIID-5822
>             Project: Teiid
>          Issue Type: Task
>          Components: Documentation
>            Reporter: Steven Hawkins
>            Assignee: Steven Hawkins
>            Priority: Major
>             Fix For: 13.x
>
>
> The gitbook cli tools are now deprecated.  An update to the pdf logic has caused the travis builds to break - we need to use an old node js version because the gitbook stuff uses old constructs, but that means an older distribution - which calibre does not support anymore.  For now I can look at customizing the calibre install, but longer term we need to get off of gitbook publishing.



--
This message was sent by Atlassian Jira
(v7.13.8#713008)