[jira] [Commented] (ATLAS-1782) Document deprecations

["Nigel Jones (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/ATLAS-1782?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16036897#comment-16036897 ] 

Nigel Jones commented on ATLAS-1782:
------------------------------------

Just noticed this... I raised ATLAS-1855 which refers to deprecation as I agree this is important too. 1782 is probably a very specific issue, 1855 touches on some broader considerations around dependency management & version compatability too.

Specifically on deprecation that section #11 documented by Hive looks like a good starting point for compatability issues, though it doesn't quite answer the specifics of a deprecation policy (be it one release or two releases etc). Any APIs marked as experimental/tech preview one could probably argue can disappear/change in the next release without significant mitigation planning, whilst anything not (and hence supported) probably should be R+2 IMO.

> Document deprecations
> ---------------------
>
>                 Key: ATLAS-1782
>                 URL: https://issues.apache.org/jira/browse/ATLAS-1782
>             Project: Atlas
>          Issue Type: Improvement
>            Reporter: Jan Hentschel
>            Priority: Minor
>
> Currently none of the deprecated classes document how its deprecation should be handled, e.g. *AtlasClient* does not mention in which version the object was deprecated, in which version the object will be removed and how it can be exchanged.



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