[teiid-issues] [JBoss JIRA] (TEIID-5649) Isolate wildfly/cli dependent documentation

Steven Hawkins (Jira) issues at jboss.org
Fri Mar 1 11:58:35 EST 2019


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

Steven Hawkins commented on TEIID-5649:
---------------------------------------

After many attempts, there doesn't appear to be a good way to get this done with gitbook.

- using if directives in the summary.adoc does not work.  It will not predictably include nor exclude based upon book.variable values
- using asciidoc variables in the summary.adoc also do not appear to work
- adding a new summary / readme in a subdirectory with parent links - link:../reference/... causes issues with images and other links

The options are:
1. Switch to a different publishing framework, like asciidoctor
2. separate the content into multiple documents - dev, reference-core, reference-wildfly, etc. 
3. use build tricks, such as overwriting the summary.adoc to control what appears in the reference

> Isolate wildfly/cli dependent documentation
> -------------------------------------------
>
>                 Key: TEIID-5649
>                 URL: https://issues.jboss.org/browse/TEIID-5649
>             Project: Teiid
>          Issue Type: Quality Risk
>          Components: Documentation
>            Reporter: Steven Hawkins
>            Assignee: Steven Hawkins
>            Priority: Major
>             Fix For: 12.1
>
>
> To better support or various environments we need to isolate docs in the main set that are dependent upon wildfly/cli.



--
This message was sent by Atlassian Jira
(v7.12.1#712002)


More information about the teiid-issues mailing list