Skip to content

Commit 3cb5ac6

Browse files
committed
docs: deprecated features page
Signed-off-by: CrazyMax <[email protected]>
1 parent faaa836 commit 3cb5ac6

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

docs/deprecated.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Deprecated features
2+
3+
This page provides an overview of features that are deprecated in BuildKit.
4+
5+
As changes are made to BuildKit there may be times when existing features need
6+
to be removed or replaced with newer features. Before an existing feature is
7+
removed it is labeled as "deprecated" within the documentation and remains in
8+
BuildKit for at least one stable release unless specified explicitly otherwise.
9+
After that time it may be removed.
10+
11+
Users are expected to take note of the list of deprecated features each release
12+
and plan their migration away from those features, and (if applicable) towards
13+
the replacement features as soon as possible.
14+
15+
The table below provides an overview of the current status of deprecated
16+
features:
17+
18+
- **Deprecated**: the feature is marked "deprecated" and should no longer be
19+
used. The feature may be removed, disabled, or change behavior in a future
20+
release. The _"Deprecated"_ column contains the release in which the feature
21+
was marked deprecated, whereas the _"Remove"_ column contains a tentative
22+
release in which the feature is to be removed. If no release is included in
23+
the _"Remove"_ column, the release is yet to be decided on.
24+
- **Removed**: the feature was removed, disabled, or hidden. Refer to the linked
25+
section for details. Some features are "soft" deprecated, which means that
26+
they remain functional for backward compatibility, and to allow users to
27+
migrate to alternatives. In such cases, a warning may be printed, and users
28+
should not rely on this feature.
29+
30+
| Status | Feature | Deprecated | Remove | Recommendation |
31+
|--------|---------|------------|--------|----------------|
32+
| | | - | - | |

0 commit comments

Comments
 (0)