[ 
https://issues.apache.org/jira/browse/AVRO-133?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12762300#action_12762300
 ] 

Scott Banachowski commented on AVRO-133:
----------------------------------------

I think the issue is with the printed/published documentation.

For example, when I print a pdf copy of the spec, the only thing that indicates 
a version is the title "Avro 1.0 Specification"

However, the spec is *much* different from one I printed several months ago, 
which also had the title "Avro 1.0 Specification".  There's no indication that 
the version is any different than the new one except by directly comparing the 
text.

I think the same is true of the spec web pages.

Adding a minor version, or perhaps a date that the spec was generate, to the 
generated web pages/ documents, would help distinguish which copies of the spec 
are newer.   Even better, if there was an addendum to the spec that highlighted 
what was updated at each version/date.


> The Avro spec must be change controlled
> ---------------------------------------
>
>                 Key: AVRO-133
>                 URL: https://issues.apache.org/jira/browse/AVRO-133
>             Project: Avro
>          Issue Type: Bug
>          Components: spec
>            Reporter: Jon Bratseth
>
> It seems currently changes are being made without bumping the version number.
> The spec should:
> - Change minor number each time any change is made
> - Include a change log listing each change and accompanying version number

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

Reply via email to