[teiid-issues] [JBoss JIRA] (TEIID-4500) Make documents to capable of building outside the GitBooks

Ramesh Reddy (JIRA) issues at jboss.org
Mon Oct 10 09:51:00 EDT 2016


Ramesh Reddy created TEIID-4500:
-----------------------------------

             Summary: Make documents to capable of building outside the GitBooks
                 Key: TEIID-4500
                 URL: https://issues.jboss.org/browse/TEIID-4500
             Project: Teiid
          Issue Type: Task
          Components: Documentation
            Reporter: Ramesh Reddy
            Assignee: Steven Hawkins
             Fix For: 9.2


Currently Teiid documentation is only built by automated process by GitBooks. However, this causes couple issues

* There is no way to check the documentation formatting external to the GitBook.
* Documents need to be always hosted by the Gitbook. I am sure there is way to export, but that may need human to do that? Going forward we would need a automated way if one wants to bundle the documents.
* Gitbook only allows two books for free, we already against this limit with no resolution with the paid route.

Thus it may be better we also have alternative ways to generate final documents, and be able to host on teiid.org. I find an example with Infinispan documents, we just need to mimic what they are doing

>> We have also implemented generation of PDFs via the
> > asciidoctor-maven-plugin with optimized post-processing via GhostScript
> > (which shrinks the size of the PDFs to a 1/4 of the size).
> > Look at [2] and [3] to see how that is done.
> > 
> > Tristan
> > 
> > [1] http://infinispan.org/docs/dev/user_guide/user_guide.html
> > [2]
> > https://github.com/infinispan/infinispan/blob/master/documentation/pom.xml
> > [3]
> > https://github.com/infinispan/infinispan/blob/master/documentation/optimize-pdf.xml 

also look at their google-analytics stuff, that is very useful to have. I do also like Infinispans style sheets better than the current default GitBook's, we should adapt them too. 



--
This message was sent by Atlassian JIRA
(v6.4.11#64026)


More information about the teiid-issues mailing list