experimental/ssh: replace verbose disclaimer with lightweight [EXPERIMENTAL] tag#5326
Open
TanishqDatabricks wants to merge 9 commits into
Open
experimental/ssh: replace verbose disclaimer with lightweight [EXPERIMENTAL] tag#5326TanishqDatabricks wants to merge 9 commits into
TanishqDatabricks wants to merge 9 commits into
Conversation
Updates the help text for `databricks ssh`, `databricks ssh connect`, and `databricks ssh setup` based on the May 1 2026 Remote Development CUJ. - `databricks ssh`: common-workflows examples now lead with serverless (no flags), with the dedicated-cluster path as a follow-up. - `databricks ssh connect`: Long description groups example invocations by serverless vs dedicated. Unhides --name, --accelerator, --ide, --environment-version so users can discover them via --help. - `databricks ssh setup`: tightened Short/Long to clarify it's for dedicated clusters; users on serverless should just use connect. Co-authored-by: Isaac
…ands Co-authored-by: Isaac
Contributor
Waiting for approvalBased on git history, these people are best suited to review:
Eligible reviewers: Suggestions based on git history. See OWNERS for ownership rules. |
anton-107
requested changes
May 26, 2026
Contributor
anton-107
left a comment
There was a problem hiding this comment.
Please remove the word "experimental" from all help notes.
That means:
- Drop the
[EXPERIMENTAL]prefix from everyShortandLonginssh.go,connect.go,setup.go, andserver.go. - Drop the "This is an experimental feature and is subject to change." line from each
Long.
If we want to signal preview status to users, let's discuss what wording to use instead — but as it stands, "experimental" should not appear in any of the help text.
…MENTAL] tag Co-authored-by: Isaac
…nt, drop [EXPERIMENTAL] - Hide --environment-version flag (not ready for users) - Replace tabs with spaces so # comments align consistently - Use <name> instead of <connection> to match the --name flag - Remove [EXPERIMENTAL] tag and disclaimer from all three commands Co-authored-by: Isaac
Co-authored-by: Isaac
5f18ec2 to
d897358
Compare
Contributor
|
An authorized user can trigger integration tests manually by following the instructions below: Trigger: Inputs:
Checks will be approved automatically on success. |
anton-107
approved these changes
May 26, 2026
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
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
disclaimerconstant (preview status, billing, SLA language)[EXPERIMENTAL]prefix toShortandLongdescriptions for all ssh commands (ssh,connect,setup,server)bundle config-remote-syncStacked on #5325 — merge that first.
Test plan
databricks ssh --help,databricks ssh connect --help,databricks ssh setup --help,databricks ssh server --helpshow[EXPERIMENTAL]tag instead of disclaimerThis pull request and its description were written by Isaac.