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.

Sign up for GitHub

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-beta] Change preview and beta language in API lifecycle guide #27029

Merged
merged 1 commit into from
Jan 10, 2025
+7 −7
Merged

[docs-beta] Change preview and beta language in API lifecycle guide #27029

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/docs-beta/docs/api/api-lifecycle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ The lifecycle stages described below provide a clear framework for understanding

## API lifecycle stages

| Stage | Description | Lifetime |
|---------|------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|
| Preview | API in the design phase, can change significantly, or be removed completely. Not for production use. | Until design is complete, or implementation cancelled |
| Beta | Features that is still being tested and may change. More stable than Preview, but still subject to change. | At most, two 1.x releases before it is either considered stable or returned to preview |
| Generally Available (GA)| Ready for production use, with minimal risk of breaking changes. | Supported until at least 2.0
| Superseded | This API is still available, but is no longer the best practice. A better alternative is available. | Supported until at least 2.0
| Deprecated | API is still available but will be removed in the future; avoid new usage. | Will be removed in a minor release, the DeprecationWarning will indicate the next release that will remove the API.
| Stage | Description | Lifetime |
|---------|-----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|
| Preview | This API may have breaking changes in patch version releases. This feature is not considered ready for production use. | Until design is complete, or implementation cancelled |
| Beta | This API may have breaking changes in minor version releases, with behavior changes in patch releases. | At most, two 1.x releases before it is either considered stable or returned to preview |
| Generally Available (GA)| Ready for production use, with minimal risk of breaking changes. | Supported until at least 2.0
| Superseded | This API is still available, but is no longer the best practice. A better alternative is available. | Supported until at least 2.0
| Deprecated | API is still available but will be removed in the future; avoid new usage. | Will be removed in a minor release, the DeprecationWarning will indicate the next release that will remove the API.


## Understanding the stages
Expand Down
Loading