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

Deprecation policy (SC-1625) #3094

Open
wants to merge 4 commits into
base: docs
Choose a base branch
from
Open

Deprecation policy (SC-1625) #3094

wants to merge 4 commits into from

Conversation

orndorffgrant
Copy link
Collaborator

This adds our deprecation policy to a new explanation page.

@github-actions github-actions bot added the docs label Apr 30, 2024
@lucasmoura lucasmoura requested a review from s-makin May 6, 2024 10:07
Copy link
Contributor

@s-makin s-makin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some nits, but also a few questions and suggestions :)

docs/explanations/deprecation_policy.rst Outdated Show resolved Hide resolved
docs/explanations/deprecation_policy.rst Outdated Show resolved Hide resolved
docs/explanations/deprecation_policy.rst Outdated Show resolved Hide resolved
docs/explanations/deprecation_policy.rst Outdated Show resolved Hide resolved
docs/explanations/deprecation_policy.rst Outdated Show resolved Hide resolved
docs/explanations/deprecation_policy.rst Outdated Show resolved Hide resolved
docs/explanations/deprecation_policy.rst Outdated Show resolved Hide resolved
docs/explanations/deprecation_policy.rst Show resolved Hide resolved
Comment on lines 58 to 61
Once a feature is “per-release-removed” on all currently supported releases,
then we can actually delete the feature and connected code from the pro-client.
For example, if we remove a given feature in 24.10, then we will be able to
delete the code in ~2036 when 24.04 noble legacy support ends.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again this feels more like an internal implementation detail than something users will be interested in. Are we sure this page wants to live in the explanation section and not the dev docs?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point - do you think the "eventual total removal" is clear enough from the previous paragraphs that we can totally remove the "eventual total removal" section? 🙃

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would say so - particularly because we don't know for sure that Noble's legacy support will be 12 years (might be increased between now and 2036 so it would probably be better not to pin down specific dates). Feel free to remove this section :)

docs/explanations/deprecation_policy.rst Outdated Show resolved Hide resolved
Co-authored-by: Sally <sally.makin@canonical.com>
@orndorffgrant
Copy link
Collaborator Author

@s-makin this is ready for re-review when you have time :)

any integration point with machine-readable output (e.g. our API functions, any
command with JSON-formatted output). It is also true for important features
that, even if lacking intentional machine-usability, are likely to be used in
automation (e.g. any form of `pro attach` or `pro enable` that doesn't require
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
automation (e.g. any form of `pro attach` or `pro enable` that doesn't require
automation (e.g. any form of ``pro attach`` or ``pro enable`` that doesn't require

======================================================

When a feature is removed in e.g. 24.10 onward, it will continue to exist in
all prior supported releases; however, features in `pro` are often expected to
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
all prior supported releases; however, features in `pro` are often expected to
all prior supported releases; however, features in ``pro`` are often expected to

Copy link
Contributor

@s-makin s-makin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple of nits now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants