docs: update SSH command format to use suffix (#18085)

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.

<img width="418" alt="image"
src="https://github.com/user-attachments/assets/3893f840-9ce1-4803-a013-736068feb328"
/>
This commit is contained in:
Atif Ali
2025-06-02 20:13:08 -07:00
committed by GitHub
parent fd6981e514
commit cba69f3d98
9 changed files with 12 additions and 10 deletions
+1 -1
View File
@@ -1097,7 +1097,7 @@
},
{
"title": "config-ssh",
"description": "Add an SSH Host entry for your workspaces \"ssh coder.workspace\"",
"description": "Add an SSH Host entry for your workspaces \"ssh workspace.coder\"",
"path": "reference/cli/config-ssh.md"
},
{
+1 -1
View File
@@ -1,7 +1,7 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# config-ssh
Add an SSH Host entry for your workspaces "ssh coder.workspace"
Add an SSH Host entry for your workspaces "ssh workspace.coder"
## Usage
+1 -1
View File
@@ -41,7 +41,7 @@ Coder — A tool for provisioning self-hosted development environments with Terr
| [<code>users</code>](./users.md) | Manage users |
| [<code>version</code>](./version.md) | Show coder version |
| [<code>autoupdate</code>](./autoupdate.md) | Toggle auto-update policy for a workspace |
| [<code>config-ssh</code>](./config-ssh.md) | Add an SSH Host entry for your workspaces "ssh coder.workspace" |
| [<code>config-ssh</code>](./config-ssh.md) | Add an SSH Host entry for your workspaces "ssh workspace.coder" |
| [<code>create</code>](./create.md) | Create a workspace |
| [<code>delete</code>](./delete.md) | Delete a workspace |
| [<code>favorite</code>](./favorite.md) | Add a workspace to your favorites |
+1 -2
View File
@@ -103,9 +103,8 @@ jobs:
- name: Create a test workspace and run some example commands
run: |
coder create -t $TEMPLATE_NAME --template-version ${{ steps.name.outputs.version_name }} test-${{ steps.name.outputs.version_name }} --yes
coder config-ssh --yes
# run some example commands
ssh coder.test-${{ steps.name.outputs.version_name }} -- make build
coder ssh test-${{ steps.name.outputs.version_name }} -- make build
- name: Delete the test workspace
if: always()