From dd09c5e090e5156c341748ac017702149ab4a22f Mon Sep 17 00:00:00 2001 From: Ammar Bandukwala Date: Tue, 25 Jul 2023 02:17:02 +0000 Subject: [PATCH] docs: fix duplicate sentence Resolves #8664 --- cli/portforward.go | 2 +- cli/testdata/coder_--help.golden | 3 +- cli/testdata/coder_port-forward_--help.golden | 4 +- docs/cli.md | 68 +++++++++---------- docs/cli/port-forward.md | 2 +- docs/manifest.json | 2 +- 6 files changed, 40 insertions(+), 41 deletions(-) diff --git a/cli/portforward.go b/cli/portforward.go index a8ae4c9f75d6d..3df1a6f6c9d9f 100644 --- a/cli/portforward.go +++ b/cli/portforward.go @@ -32,7 +32,7 @@ func (r *RootCmd) portForward() *clibase.Cmd { client := new(codersdk.Client) cmd := &clibase.Cmd{ Use: "port-forward ", - 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".`, + Short: `Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R".`, Aliases: []string{"tunnel"}, Long: formatExamples( example{ diff --git a/cli/testdata/coder_--help.golden b/cli/testdata/coder_--help.golden index 3395b6ecd30b5..e074756680e84 100644 --- a/cli/testdata/coder_--help.golden +++ b/cli/testdata/coder_--help.golden @@ -21,8 +21,7 @@ Coder v0.0.0-devel — A tool for provisioning self-hosted development environme logout Unauthenticate your local session netcheck Print network debug information for DERP and STUN ping Ping a workspace - port-forward Forward ports from a workspace to the local machine. - Forward ports from a workspace to the local machine. For + port-forward Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R". publickey Output your Coder public key used for Git operations rename Rename a workspace diff --git a/cli/testdata/coder_port-forward_--help.golden b/cli/testdata/coder_port-forward_--help.golden index a6eb7d936b8e6..35c314d400699 100644 --- a/cli/testdata/coder_port-forward_--help.golden +++ b/cli/testdata/coder_port-forward_--help.golden @@ -1,7 +1,7 @@ Usage: coder port-forward [flags] -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". +Forward ports from a workspace to the local machine. For reverse port +forwarding, use "coder ssh -R". Aliases: tunnel diff --git a/docs/cli.md b/docs/cli.md index 95fbbabc95677..1a0c40a22fca6 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -23,40 +23,40 @@ Coder — A tool for provisioning self-hosted development environments with Terr ## Subcommands -| Name | Purpose | -| ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [config-ssh](./cli/config-ssh.md) | Add an SSH Host entry for your workspaces "ssh coder.workspace" | -| [create](./cli/create.md) | Create a workspace | -| [delete](./cli/delete.md) | Delete a workspace | -| [dotfiles](./cli/dotfiles.md) | Personalize your workspace by applying a canonical dotfiles repository | -| [features](./cli/features.md) | List Enterprise features | -| [groups](./cli/groups.md) | Manage groups | -| [licenses](./cli/licenses.md) | Add, delete, and list licenses | -| [list](./cli/list.md) | List workspaces | -| [login](./cli/login.md) | Authenticate with Coder deployment | -| [logout](./cli/logout.md) | Unauthenticate your local session | -| [netcheck](./cli/netcheck.md) | Print network debug information for DERP and STUN | -| [ping](./cli/ping.md) | Ping a workspace | -| [port-forward](./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". | -| [provisionerd](./cli/provisionerd.md) | Manage provisioner daemons | -| [publickey](./cli/publickey.md) | Output your Coder public key used for Git operations | -| [rename](./cli/rename.md) | Rename a workspace | -| [reset-password](./cli/reset-password.md) | Directly connect to the database to reset a user's password | -| [restart](./cli/restart.md) | Restart a workspace | -| [schedule](./cli/schedule.md) | Schedule automated start and stop times for workspaces | -| [server](./cli/server.md) | Start a Coder server | -| [show](./cli/show.md) | Display details of a workspace's resources and agents | -| [speedtest](./cli/speedtest.md) | Run upload and download tests from your machine to a workspace | -| [ssh](./cli/ssh.md) | Start a shell into a workspace | -| [start](./cli/start.md) | Start a workspace | -| [stat](./cli/stat.md) | Show resource usage for the current workspace. | -| [state](./cli/state.md) | Manually manage Terraform state to fix broken workspaces | -| [stop](./cli/stop.md) | Stop a workspace | -| [templates](./cli/templates.md) | Manage templates | -| [tokens](./cli/tokens.md) | Manage personal access tokens | -| [update](./cli/update.md) | Will update and start a given workspace if it is out of date | -| [users](./cli/users.md) | Manage users | -| [version](./cli/version.md) | Show coder version | +| Name | Purpose | +| ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| [config-ssh](./cli/config-ssh.md) | Add an SSH Host entry for your workspaces "ssh coder.workspace" | +| [create](./cli/create.md) | Create a workspace | +| [delete](./cli/delete.md) | Delete a workspace | +| [dotfiles](./cli/dotfiles.md) | Personalize your workspace by applying a canonical dotfiles repository | +| [features](./cli/features.md) | List Enterprise features | +| [groups](./cli/groups.md) | Manage groups | +| [licenses](./cli/licenses.md) | Add, delete, and list licenses | +| [list](./cli/list.md) | List workspaces | +| [login](./cli/login.md) | Authenticate with Coder deployment | +| [logout](./cli/logout.md) | Unauthenticate your local session | +| [netcheck](./cli/netcheck.md) | Print network debug information for DERP and STUN | +| [ping](./cli/ping.md) | Ping a workspace | +| [port-forward](./cli/port-forward.md) | Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R". | +| [provisionerd](./cli/provisionerd.md) | Manage provisioner daemons | +| [publickey](./cli/publickey.md) | Output your Coder public key used for Git operations | +| [rename](./cli/rename.md) | Rename a workspace | +| [reset-password](./cli/reset-password.md) | Directly connect to the database to reset a user's password | +| [restart](./cli/restart.md) | Restart a workspace | +| [schedule](./cli/schedule.md) | Schedule automated start and stop times for workspaces | +| [server](./cli/server.md) | Start a Coder server | +| [show](./cli/show.md) | Display details of a workspace's resources and agents | +| [speedtest](./cli/speedtest.md) | Run upload and download tests from your machine to a workspace | +| [ssh](./cli/ssh.md) | Start a shell into a workspace | +| [start](./cli/start.md) | Start a workspace | +| [stat](./cli/stat.md) | Show resource usage for the current workspace. | +| [state](./cli/state.md) | Manually manage Terraform state to fix broken workspaces | +| [stop](./cli/stop.md) | Stop a workspace | +| [templates](./cli/templates.md) | Manage templates | +| [tokens](./cli/tokens.md) | Manage personal access tokens | +| [update](./cli/update.md) | Will update and start a given workspace if it is out of date | +| [users](./cli/users.md) | Manage users | +| [version](./cli/version.md) | Show coder version | ## Options diff --git a/docs/cli/port-forward.md b/docs/cli/port-forward.md index b4b14d605392b..791960452398d 100644 --- a/docs/cli/port-forward.md +++ b/docs/cli/port-forward.md @@ -2,7 +2,7 @@ # port-forward -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". +Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R". Aliases: diff --git a/docs/manifest.json b/docs/manifest.json index 159e061e8bfde..d6c59b477f053 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -620,7 +620,7 @@ }, { "title": "port-forward", - "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\".", + "description": "Forward ports from a workspace to the local machine. For reverse port forwarding, use \"coder ssh -R\".", "path": "cli/port-forward.md" }, {