db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Rick Hillegas (JIRA)" <j...@apache.org>
Subject [jira] Commented: (DERBY-4851) Parameterize documentation sources so that release-time variables (like copyright year and release id) can be plugged in when we build a release
Date Fri, 29 Oct 2010 14:32:19 GMT

    [ https://issues.apache.org/jira/browse/DERBY-4851?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12926294#action_12926294
] 

Rick Hillegas commented on DERBY-4851:
--------------------------------------

Backing out derby-4851-03-aa-longReleaseID-and-subversionRevision.diff at subversion revision
1028763. Kim is not keen on parameterizing the examples and I understand her reservations.

In addition, Kim and I have exchanged mail with Stefan Hinz, who oversees the docs effort
for MySQL. Stefan also is not keen on parameterizing examples. He says that the MySQL group
considered several options for how to handle the timestamps and version information in examples,
which grow stale over time. They were not able to come up with a great solution to the problem.
In the end, they decided that it's ok for this information to grow stale--their users have
not objected. In the opinion of the MySQL docs team, the examples only need to be updated
if the output changes in a substantive way.


> Parameterize documentation sources so that release-time variables (like copyright year
and release id) can be plugged in when we build a release
> ------------------------------------------------------------------------------------------------------------------------------------------------
>
>                 Key: DERBY-4851
>                 URL: https://issues.apache.org/jira/browse/DERBY-4851
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Rick Hillegas
>            Assignee: Rick Hillegas
>         Attachments: derby-4851-01-aa-copyrightYear.diff, derby-4851-02-aa-shortVersionNumber.diff,
derby-4851-03-aa-longReleaseID-and-subversionRevision.diff
>
>
> Right now there are a number of strings which have to be updated in the user guides every
time that we cut a branch or generate a release candidate. We should parameterize these strings
so that the build script can fill them in. Probably we will have to use the ant substitution
task for this because there is no obvious way to do this via DITA.
> These are the variables I am aware of. Please let me know if there are others:
> Latest copyright year (currently 2010)
> 2 part version number (e.g., 10.7) (this is plugged into the ij script output, among
other uses)
> 4 part version number (e.g. 10.7.1.0)
> subversion revision number (e.g. 1000400)

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message