mirror of
https://github.com/kubernetes-sigs/node-feature-discovery.git
synced 2024-12-14 11:57:51 +00:00
Merge pull request #1279 from marquiz/docs/version-policy
docs: document version and deprecation policy
This commit is contained in:
commit
e195e8563f
1 changed files with 36 additions and 0 deletions
36
docs/reference/versions.md
Normal file
36
docs/reference/versions.md
Normal file
|
@ -0,0 +1,36 @@
|
|||
---
|
||||
title: "Versions"
|
||||
layout: default
|
||||
sort: 8
|
||||
---
|
||||
|
||||
# Versions and deprecation
|
||||
{: .no_toc}
|
||||
|
||||
---
|
||||
|
||||
## Supported versions
|
||||
|
||||
Node Feature Discovery follows [semantic versioning](https://semver.org/) where
|
||||
the version number consists of three components, i.e. **MAJOR.MINOR.PATCH**.
|
||||
|
||||
The most recent two minor releases (or release branches) of Node Feature
|
||||
Discovery are supported. That is, with X being the latest release, **X** and **X-1**
|
||||
are supported and **X-1** reaches end-of-life when **X+1** is released.
|
||||
|
||||
## Deprecation policy
|
||||
|
||||
### Feature labels
|
||||
|
||||
Built-in [feature labels](../usage/features.md) and
|
||||
[features](../usage/customization-guide.html#available-features) are supported
|
||||
for 2 releases after being deprecated, at minimum. That is, if a feature label
|
||||
is deprecated in version **X**, it will be supported in **X+1** and **X+2** and
|
||||
may be dropped in **X+3**.
|
||||
|
||||
### Configuration options
|
||||
|
||||
Command-line flags and configuration file options are supported for 1 more
|
||||
release after being deprecated, at minimum. That is, if option/flag is
|
||||
deprecated in version **X**, it will be supported in **X+1** and may be removed
|
||||
in **X+2**.
|
Loading…
Reference in a new issue