[teiid-issues] [JBoss JIRA] (TEIID-5975) xref links are broken in docs and other doc issues

Steven Hawkins (Jira) issues at jboss.org
Thu Jun 18 09:21:48 EDT 2020


    [ https://issues.redhat.com/browse/TEIID-5975?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14164966#comment-14164966 ] 

Steven Hawkins commented on TEIID-5975:
---------------------------------------

> They produce an invalid anchor link in the current doc.

I don't see a great workaround here.  Updating the links to be  external will break the product build and it will be a lot of work to instead change the current gitbook to perform all of the includes that effectively inline content that the product build does.  That unfortunately leaves us with using templating to produce a different link depending on the build target.

> xref links are broken in docs and other doc issues
> --------------------------------------------------
>
>                 Key: TEIID-5975
>                 URL: https://issues.redhat.com/browse/TEIID-5975
>             Project: Teiid
>          Issue Type: Bug
>          Components: Documentation
>            Reporter: Steven Hawkins
>            Assignee: Steven Hawkins
>            Priority: Major
>
> Productization changes to use xref for links do not render correctly with the usual gitbook build.  They produce an invalid anchor link in the current doc.
> There are also some pages that look like they weren't updated to the new page names.  Running a regex like 
> {noformat}
> :[^/A-Z:]*[A-Z][^/:]*.adoc
> {noformat}
>  over the reference guide shows at least 86 now invalid links. [~broldan] do you have a master list of old to new doc file names that could script getting those updated?



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


More information about the teiid-issues mailing list