Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document a deprecation strategy #1956

Open
MVrachev opened this issue Apr 14, 2022 · 2 comments
Open

Document a deprecation strategy #1956

MVrachev opened this issue Apr 14, 2022 · 2 comments
Labels
discussion Discussions related to the design, implementation and operation of the project documentation Documentation of the project as well as procedural documentation

Comments

@MVrachev
Copy link
Collaborator

Description of issue or feature request:
With the release of python-tuf 1.0.0 and the soon integration of python-tuf inside Warehouse we should decide and document what will our depreciation strategy be.

For example: in my pr #1948 @jku has suggested that we should deprecate DelegatedRole.is_delegated_path() API call.
I have a couple of questions:

  1. How do we document this in the function docstring?
  2. Where else do we want to document the depreciation?
  3. How many versions of python-tuf we will keep the deprecated method before its removal?
  4. Maybe it will be good to have the process to create an issue for each API call that we want to deprecate and that way we can keep track of the APIs we want to deprecate?

Current behavior:
No depreciation strategy.

Expected behavior:
Define one and maybe document it in an ADR and start following it.

@MVrachev MVrachev changed the title Document a depreciation strategy Document a deprecation strategy Apr 14, 2022
@MVrachev
Copy link
Collaborator Author

On point 4 - having a separate issue about the deprecation of an API will be like an announcement and will give the users the opportunity to complain, ask for more versions to support the API, and a place for a discussion about when should this API be removed.

@ivanayov ivanayov added documentation Documentation of the project as well as procedural documentation discussion Discussions related to the design, implementation and operation of the project labels Apr 20, 2022
@ivanayov
Copy link
Collaborator

Related to #1127

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Discussions related to the design, implementation and operation of the project documentation Documentation of the project as well as procedural documentation
Projects
None yet
Development

No branches or pull requests

2 participants