docs: define beta support matrix#2148
Draft
drew wants to merge 21 commits into
Draft
Conversation
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
|
🌿 Preview your docs: https://nvidia-preview-pr-2148.docs.buildwithfern.com/openshell |
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
krishicks
reviewed
Jul 6, 2026
krishicks
reviewed
Jul 6, 2026
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
elezar
reviewed
Jul 7, 2026
elezar
reviewed
Jul 7, 2026
| | Release phase | Compatibility policy | | ||
| | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | Beta | Patch releases are backward compatible. A minor release may contain a breaking API change only after the affected API is deprecated in the preceding minor release. The release includes migration guidance and coordinated SDK updates. | | ||
| | Stable | Minor and patch releases are backward compatible within an API major version. Breaking changes use a new versioned Protobuf package and API major version. The previous stable API remains supported for at least 12 months or two minor releases after its replacement, whichever is longer. | |
Member
There was a problem hiding this comment.
Could you comment on where the specific time window came from?
Collaborator
Author
There was a problem hiding this comment.
It's arbitrary. We can probably remove Stable guidance and save it for GA.
elezar
reviewed
Jul 7, 2026
| The gateway can manage sandboxes through several compute drivers. | ||
| | Driver | Supported hosts | Minimum version | Requirements | | ||
| | ---------- | --------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------- | | ||
| | Docker | macOS, Linux, Windows | 28.0.4 or later | Docker Engine or Docker Desktop. | |
Member
There was a problem hiding this comment.
Did we need to distinguish between "Windows" and "WSL"?
Collaborator
Author
There was a problem hiding this comment.
Seems like we prefer Windows, #2071 (comment).
elezar
reviewed
Jul 7, 2026
elezar
reviewed
Jul 7, 2026
elezar
reviewed
Jul 7, 2026
Co-authored-by: Evan Lezar <elezar@nvidia.com>
Co-authored-by: Evan Lezar <elezar@nvidia.com>
Co-authored-by: Evan Lezar <elezar@nvidia.com>
Co-authored-by: Evan Lezar <elezar@nvidia.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Define the forward-looking OpenShell compatibility matrix for the beta milestone. This draft establishes the intended support contract and includes explicit TBD values where minimum versions are not yet finalized.
The initial minimum versions are deliberately provisional. They are reasonable starting points rather than fully validated support boundaries, and we will refine them as compatibility and release test infrastructure comes online.
Related Issue
None.
Changes
Testing
mise run pre-commitpassesChecklist