Skip to content

docs: update SSH command format to use suffix #18085

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.

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

Merged
merged 1 commit into from
Jun 3, 2025
Merged

Conversation

matifali
Copy link
Member

@matifali matifali commented May 28, 2025

Refactor the workspace SSH command syntax across the project to use the "workspace.coder" format instead of "coder.workspace". This standardizes the SSH host entries for better consistency and clarity.

This is a follow-up from #17445 and recommends using the suffix-based format for all new Coder versions.

image

@matifali matifali changed the title docs: update SSH command format to "workspace.coder" docs: update SSH command format to use suffix May 28, 2025
@matifali matifali requested a review from BrunoQuaresma May 28, 2025 18:49
@matifali
Copy link
Member Author

@BrunoQuaresma it also touches a few UI components to update the in product instructions so I asked you for a review too.

@matifali matifali requested a review from ethanndickson May 29, 2025 10:21
@matifali matifali closed this May 30, 2025
@matifali matifali force-pushed the atif/update-ssh-docs branch from f32220a to a19539c Compare May 30, 2025 10:40
@github-actions github-actions bot locked and limited conversation to collaborators May 30, 2025
@matifali matifali reopened this May 30, 2025
@coder coder unlocked this conversation May 30, 2025
@matifali matifali force-pushed the atif/update-ssh-docs branch from 7630225 to 9a80344 Compare May 30, 2025 11:03
Revise various parts of the CLI and documentation to reflect the new SSH connection format for workspaces. Update usage examples from the outdated "ssh coder.workspace" format to the new "ssh workspace.coder" format. Additionally, ensure correct formation in commands by adding workspace owner username and hostname suffix through recent data sources.
@matifali matifali force-pushed the atif/update-ssh-docs branch from 9a80344 to 98e7860 Compare May 30, 2025 11:03
@matifali matifali merged commit cba69f3 into main Jun 3, 2025
38 of 39 checks passed
@matifali matifali deleted the atif/update-ssh-docs branch June 3, 2025 03:13
@github-actions github-actions bot locked and limited conversation to collaborators Jun 3, 2025
@matifali matifali restored the atif/update-ssh-docs branch June 3, 2025 14:04
@matifali
Copy link
Member Author

matifali commented Jun 3, 2025

/cherry-pick release/2.23

@matifali matifali deleted the atif/update-ssh-docs branch June 3, 2025 14:20
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants