[jira] [Resolved] (IMPALA-4643) Consolidate links that point outside the Impala doc bundle

["John Russell (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/IMPALA-4643?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

John Russell resolved IMPALA-4643.
----------------------------------
    Resolution: Fixed

> Consolidate links that point outside the Impala doc bundle
> ----------------------------------------------------------
>
>                 Key: IMPALA-4643
>                 URL: https://issues.apache.org/jira/browse/IMPALA-4643
>             Project: IMPALA
>          Issue Type: Sub-task
>          Components: Docs
>    Affects Versions: Impala 2.7.0
>            Reporter: John Russell
>            Assignee: John Russell
>            Priority: Minor
>              Labels: asf
>
> A number of "see also" sorts of references point to related topics in the CDH doc library. This work item is for reorg and simplication to get rid of many <xref> tags that are unused by the standalone Impala docs, and many http:// links pointing to doc pages on cloudera.com.
> We always preserved the ability to get a clean Impala-only doc build be conditionalizing them like so:
> {code}
> impala_views.xml:        <xref audience="integrated" href="sg_hive_sql.xml#concept_c2q_4qx_p4/col_level_auth_sentry"/><xref audience="standalone" href="https://www.cloudera.com/documentation/enterprise/latest/topics/sg_hive_sql.html" format="html" scope="external"/>
> {code}
> The Impala-only doc build uses the 'standalone' condition, which means that only the link that resolves to the http:// URL is processed, and the missing sg_hive_sql.xml file doesn't cause a doc build error.
> This work item is to use the DITA <keydef> tag and keyref= attribute for <xref> tags to make these external links easier to genericize. That DITA facility uses a side file similar to a .h where link destinations are centralized. The double <xref> tags with different conditions are condensed down to something like:
> {code}
> <xref keyref="sentry_hive_syntax"/>
> {code}
> and the side file can be customized to make the link point to a local .xml file, a remote http:// URL, or even become plain text instead of a link.
> (This mechanism relies on the same <keydef> tag / keyref= attribute that we use for short text substitutions like for the Impala release numbers. That tagging idiom does double duty.)



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)