[
https://issues.apache.org/jira/browse/DERBY-1590?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12484199
]
Kim Haase commented on DERBY-1590:
----------------------------------
Sorry, our comments "crossed in the mail". Yes, I agree that it's fine to do
these cleanups as a separate issue. Saves me making that extra patch for just
the two files.
There are some occurrences of "Derby" here and there instead of the
"productshortname" conref. We can't use the conref in titles or index entries,
I am pretty sure, but we might try to use it in plain text where possible.
> Consolidate the *conrefs.dita files in the documentation source tree to a
> single file.
> --------------------------------------------------------------------------------------
>
> Key: DERBY-1590
> URL: https://issues.apache.org/jira/browse/DERBY-1590
> Project: Derby
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 10.1.3.1, 10.2.1.6
> Reporter: Andrew McIntyre
> Assigned To: Kim Haase
> Fix For: 10.3.0.0
>
> Attachments: conrefs.dita, DERBY-1590-adminguide.diff,
> DERBY-1590-adminguide.stat, DERBY-1590.diff, DERBY-1590.stat
>
>
> Currently each book of the documentation contains its own conref file, which
> contains reusable content which can be included by reference in the
> documentation. These files, e.g. src/devguide/devconrefs.dita,
> src/getstart/gsconrefs.dita, should be consolidated to a single file,
> probably in the src directory, and the conref URLs updated to include a
> relative path up one level to the new file. This way, all of the manuals can
> share a single conref file and this content would not need to be duplicated.
> This would allow, for example, updating all the appropriate references to the
> version number in the documentation by updating a single file.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
