Uh oh!
There was an error while loading. Please reload this page.
experimental/ssh: replace verbose disclaimer with lightweight [EXPERIMENTAL] tag - #5326
experimental/ssh: replace verbose disclaimer with lightweight [EXPERIMENTAL] tag#5326TanishqDatabricks 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
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
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
d897358CompareAn authorized user can trigger integration tests manually by following the instructions below: Trigger: Inputs:
Checks will be approved automatically on success. |
## Summary - Replace verbose disclaimer with lightweight tag, then drop [EXPERIMENTAL] entirely - Hide env-version flag, fix alignment in help text - Replace tabs with spaces, update `<connection>` to `<name>` in examples Supersedes #5325 and #5326 (fork PRs that couldn't run CI). ## Test plan - [ ] Verify `databricks ssh --help`, `databricks ssh connect --help`, `databricks ssh setup --help` output - [ ] CI passes (including `test-exp-ssh`)
## Summary - Replace verbose disclaimer with lightweight tag, then drop [EXPERIMENTAL] entirely - Hide env-version flag, fix alignment in help text - Replace tabs with spaces, update `<connection>` to `<name>` in examples Supersedes #5325 and #5326 (fork PRs that couldn't run CI). ## Test plan - [ ] Verify `databricks ssh --help`, `databricks ssh connect --help`, `databricks ssh setup --help` output - [ ] CI passes (including `test-exp-ssh`)
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.