community icon indicating copy to clipboard operation
community copied to clipboard

Define criteria for different API maturity levels / API conventions

Open pmorie opened this issue 4 years ago • 4 comments

In many places we refer to "alpha", "beta", and "stable" or "GA" API levels, but these are not formalized anywhere. We should explicitly define the properties of these different levels and criteria that must be met to be considered a particular level.

Closely related to the concept of API maturity levels is having clear API conventions that must be followed so that APIs within the ecosystem "feel" consistent and meet user expectations; we should also clearly define conventions for our APIs.

pmorie avatar May 28 '20 18:05 pmorie

Is this still relevant?

aliok avatar Jan 12 '24 08:01 aliok

We have the following document - can @knative/technical-oversight-committee review and see if it is sufficient https://github.com/knative/community/blob/main/mechanics/MATURITY-LEVELS.md

dprotaso avatar Jan 17 '24 15:01 dprotaso

The focus of the Maturity Levels doc is mostly about the process of migrating to core.

We've also got this page in the docs, though it's a Serving page, so Eventing / Functions might not follow these exactly. But if we had a common understanding, maybe we could pull some of the info on alpha / beta / GA from there into the Maturity Levels doc?

psschwei avatar Jan 31 '24 14:01 psschwei

Talked during TOC Meeting - @psschwei will update the doc to incorporate the definitions of Alpha, Beta, GA.

dprotaso avatar Jan 31 '24 15:01 dprotaso