Skip to content

Commit f6f61df

Browse files
authored
docs: fix duplicate sentence (#8712)
Resolves #8664
1 parent b8e792b commit f6f61df

File tree

6 files changed

+40
-41
lines changed

6 files changed

+40
-41
lines changed

cli/portforward.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ func (r *RootCmd) portForward() *clibase.Cmd {
3232
client := new(codersdk.Client)
3333
cmd := &clibase.Cmd{
3434
Use: "port-forward <workspace>",
35-
Short: `Forward ports from a workspace to the local machine. Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R".`,
35+
Short: `Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R".`,
3636
Aliases: []string{"tunnel"},
3737
Long: formatExamples(
3838
example{

cli/testdata/coder_--help.golden

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ Coder v0.0.0-devel — A tool for provisioning self-hosted development environme
2121
logout Unauthenticate your local session
2222
netcheck Print network debug information for DERP and STUN
2323
ping Ping a workspace
24-
port-forward Forward ports from a workspace to the local machine.
25-
Forward ports from a workspace to the local machine. For
24+
port-forward Forward ports from a workspace to the local machine. For
2625
reverse port forwarding, use "coder ssh -R".
2726
publickey Output your Coder public key used for Git operations
2827
rename Rename a workspace

cli/testdata/coder_port-forward_--help.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Usage: coder port-forward [flags] <workspace>
22

3-
Forward ports from a workspace to the local machine. Forward ports from a
4-
workspace to the local machine. For reverse port forwarding, use "coder ssh -R".
3+
Forward ports from a workspace to the local machine. For reverse port
4+
forwarding, use "coder ssh -R".
55

66
Aliases: tunnel
77

docs/cli.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -23,40 +23,40 @@ Coder — A tool for provisioning self-hosted development environments with Terr
2323

2424
## Subcommands
2525

26-
| Name | Purpose |
27-
| ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
28-
| [<code>config-ssh</code>](./cli/config-ssh.md) | Add an SSH Host entry for your workspaces "ssh coder.workspace" |
29-
| [<code>create</code>](./cli/create.md) | Create a workspace |
30-
| [<code>delete</code>](./cli/delete.md) | Delete a workspace |
31-
| [<code>dotfiles</code>](./cli/dotfiles.md) | Personalize your workspace by applying a canonical dotfiles repository |
32-
| [<code>features</code>](./cli/features.md) | List Enterprise features |
33-
| [<code>groups</code>](./cli/groups.md) | Manage groups |
34-
| [<code>licenses</code>](./cli/licenses.md) | Add, delete, and list licenses |
35-
| [<code>list</code>](./cli/list.md) | List workspaces |
36-
| [<code>login</code>](./cli/login.md) | Authenticate with Coder deployment |
37-
| [<code>logout</code>](./cli/logout.md) | Unauthenticate your local session |
38-
| [<code>netcheck</code>](./cli/netcheck.md) | Print network debug information for DERP and STUN |
39-
| [<code>ping</code>](./cli/ping.md) | Ping a workspace |
40-
| [<code>port-forward</code>](./cli/port-forward.md) | Forward ports from a workspace to the local machine. Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R". |
41-
| [<code>provisionerd</code>](./cli/provisionerd.md) | Manage provisioner daemons |
42-
| [<code>publickey</code>](./cli/publickey.md) | Output your Coder public key used for Git operations |
43-
| [<code>rename</code>](./cli/rename.md) | Rename a workspace |
44-
| [<code>reset-password</code>](./cli/reset-password.md) | Directly connect to the database to reset a user's password |
45-
| [<code>restart</code>](./cli/restart.md) | Restart a workspace |
46-
| [<code>schedule</code>](./cli/schedule.md) | Schedule automated start and stop times for workspaces |
47-
| [<code>server</code>](./cli/server.md) | Start a Coder server |
48-
| [<code>show</code>](./cli/show.md) | Display details of a workspace's resources and agents |
49-
| [<code>speedtest</code>](./cli/speedtest.md) | Run upload and download tests from your machine to a workspace |
50-
| [<code>ssh</code>](./cli/ssh.md) | Start a shell into a workspace |
51-
| [<code>start</code>](./cli/start.md) | Start a workspace |
52-
| [<code>stat</code>](./cli/stat.md) | Show resource usage for the current workspace. |
53-
| [<code>state</code>](./cli/state.md) | Manually manage Terraform state to fix broken workspaces |
54-
| [<code>stop</code>](./cli/stop.md) | Stop a workspace |
55-
| [<code>templates</code>](./cli/templates.md) | Manage templates |
56-
| [<code>tokens</code>](./cli/tokens.md) | Manage personal access tokens |
57-
| [<code>update</code>](./cli/update.md) | Will update and start a given workspace if it is out of date |
58-
| [<code>users</code>](./cli/users.md) | Manage users |
59-
| [<code>version</code>](./cli/version.md) | Show coder version |
26+
| Name | Purpose |
27+
| ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- |
28+
| [<code>config-ssh</code>](./cli/config-ssh.md) | Add an SSH Host entry for your workspaces "ssh coder.workspace" |
29+
| [<code>create</code>](./cli/create.md) | Create a workspace |
30+
| [<code>delete</code>](./cli/delete.md) | Delete a workspace |
31+
| [<code>dotfiles</code>](./cli/dotfiles.md) | Personalize your workspace by applying a canonical dotfiles repository |
32+
| [<code>features</code>](./cli/features.md) | List Enterprise features |
33+
| [<code>groups</code>](./cli/groups.md) | Manage groups |
34+
| [<code>licenses</code>](./cli/licenses.md) | Add, delete, and list licenses |
35+
| [<code>list</code>](./cli/list.md) | List workspaces |
36+
| [<code>login</code>](./cli/login.md) | Authenticate with Coder deployment |
37+
| [<code>logout</code>](./cli/logout.md) | Unauthenticate your local session |
38+
| [<code>netcheck</code>](./cli/netcheck.md) | Print network debug information for DERP and STUN |
39+
| [<code>ping</code>](./cli/ping.md) | Ping a workspace |
40+
| [<code>port-forward</code>](./cli/port-forward.md) | Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R". |
41+
| [<code>provisionerd</code>](./cli/provisionerd.md) | Manage provisioner daemons |
42+
| [<code>publickey</code>](./cli/publickey.md) | Output your Coder public key used for Git operations |
43+
| [<code>rename</code>](./cli/rename.md) | Rename a workspace |
44+
| [<code>reset-password</code>](./cli/reset-password.md) | Directly connect to the database to reset a user's password |
45+
| [<code>restart</code>](./cli/restart.md) | Restart a workspace |
46+
| [<code>schedule</code>](./cli/schedule.md) | Schedule automated start and stop times for workspaces |
47+
| [<code>server</code>](./cli/server.md) | Start a Coder server |
48+
| [<code>show</code>](./cli/show.md) | Display details of a workspace's resources and agents |
49+
| [<code>speedtest</code>](./cli/speedtest.md) | Run upload and download tests from your machine to a workspace |
50+
| [<code>ssh</code>](./cli/ssh.md) | Start a shell into a workspace |
51+
| [<code>start</code>](./cli/start.md) | Start a workspace |
52+
| [<code>stat</code>](./cli/stat.md) | Show resource usage for the current workspace. |
53+
| [<code>state</code>](./cli/state.md) | Manually manage Terraform state to fix broken workspaces |
54+
| [<code>stop</code>](./cli/stop.md) | Stop a workspace |
55+
| [<code>templates</code>](./cli/templates.md) | Manage templates |
56+
| [<code>tokens</code>](./cli/tokens.md) | Manage personal access tokens |
57+
| [<code>update</code>](./cli/update.md) | Will update and start a given workspace if it is out of date |
58+
| [<code>users</code>](./cli/users.md) | Manage users |
59+
| [<code>version</code>](./cli/version.md) | Show coder version |
6060

6161
## Options
6262

docs/cli/port-forward.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -620,7 +620,7 @@
620620
},
621621
{
622622
"title": "port-forward",
623-
"description": "Forward ports from a workspace to the local machine. Forward ports from a workspace to the local machine. For reverse port forwarding, use \"coder ssh -R\".",
623+
"description": "Forward ports from a workspace to the local machine. For reverse port forwarding, use \"coder ssh -R\".",
624624
"path": "cli/port-forward.md"
625625
},
626626
{

0 commit comments

Comments
 (0)