debian-mirror-gitlab/doc/development/deprecation_guidelines/index.md

38 lines
1.6 KiB
Markdown
Raw Normal View History

2021-01-29 00:20:46 +05:30
---
stage: none
group: unassigned
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2021-01-29 00:20:46 +05:30
---
2020-10-24 23:57:45 +05:30
# Deprecation guidelines
This page includes information about how and when to remove or make breaking
changes to GitLab features.
## Terminology
It's important to understand the difference between **deprecation** and
**removal**:
2021-09-30 23:02:18 +05:30
**Deprecation** is the process of flagging/marking/announcing that a feature is no longer fully supported and may be removed in a future version of GitLab.
2020-10-24 23:57:45 +05:30
**Removal** is the process of actually removing a feature that was previously
deprecated.
## When can a feature be deprecated?
A feature can be deprecated at any time, provided there is a viable alternative.
2021-09-04 01:27:46 +05:30
Deprecations should be announced via [release posts](https://about.gitlab.com/handbook/marketing/blog/release-posts/#deprecations).
2020-10-24 23:57:45 +05:30
## When can a feature be removed/changed?
2021-09-04 01:27:46 +05:30
Generally, feature or configuration can be removed/changed only on major release.
It also should be [deprecated in advance](https://about.gitlab.com/handbook/marketing/blog/release-posts/#deprecations).
2021-09-30 23:02:18 +05:30
For API removals, see the [GraphQL](../../api/graphql/index.md#deprecation-and-removal-process) and [GitLab API](../../api/index.md#compatibility-guidelines) guidelines.
2021-04-29 21:17:54 +05:30
For configuration removals, see the [Omnibus deprecation policy](https://docs.gitlab.com/omnibus/package-information/deprecation_policy.html).
For versioning and upgrade details, see our [Release and Maintenance policy](../../policy/maintenance.md).