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

docs: add deprecation policy #5053

Merged
merged 6 commits into from
Jan 31, 2025

Conversation

ivankatliarchuk
Copy link
Contributor

@ivankatliarchuk ivankatliarchuk commented Jan 31, 2025

Description
It worth to add deprecation policy, as currently not clear how to deal with behaviors that not works as expected or capabilities that should behave differently.

Motivation

Checklist

  • Unit tests updated
  • End user documentation updated

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 31, 2025
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 31, 2025
Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@ivankatliarchuk
Copy link
Contributor Author

/kind documentation
/label tide/merge-method-squash

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. labels Jan 31, 2025
Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@ivankatliarchuk
Copy link
Contributor Author

Hi @mloiseleur wdyt?

@mloiseleur
Copy link
Contributor

That's a great idea 👍
It's far better this way.

@mloiseleur
Copy link
Contributor

/retitle docs: add deprecation policy

@k8s-ci-robot k8s-ci-robot changed the title feat(deprecation policy): added deprecation policy docs: add deprecation policy Jan 31, 2025
@mloiseleur
Copy link
Contributor

You will need to add it to mkdocs.yml, too.

ivankatliarchuk and others added 2 commits January 31, 2025 10:22
Co-authored-by: Michel Loiseleur <97035654+mloiseleur@users.noreply.github.com>
Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@ivankatliarchuk
Copy link
Contributor Author

Added and everything is resovled. Yep this uses existend deprecation policies, as no point to introduce something weird ;-)

@mloiseleur
Copy link
Contributor

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 31, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mloiseleur

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 31, 2025
@k8s-ci-robot k8s-ci-robot merged commit 8eb8ea3 into kubernetes-sigs:master Jan 31, 2025
13 checks passed
ivankatliarchuk added a commit to gofogo/k8s-sigs-external-dns-fork that referenced this pull request Feb 2, 2025
* master:
  docs: add deprecation policy (kubernetes-sigs#5053)
  style: space vs tabs
  fix: remove misleading error message
  fix(cloudflare): ignore 1002 permission denied errors in UpdateDataLocalizationRegionalHostname
@ivankatliarchuk ivankatliarchuk deleted the docs-deprecation branch February 16, 2025 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants