chore: add documentation to the coder ssh command regarding feature parity with ssh (#17827)

Closes
[coder/internal#628](https://github.com/coder/internal/issues/628)

---------

Co-authored-by: M Atif Ali <atif@coder.com>

cli/ssh.go

@@ -92,6 +92,7 @@ func (r *RootCmd) ssh() *serpent.Command {
 		Annotations: workspaceCommand,
 		Use:         "ssh <workspace>",
 		Short:       "Start a shell into a workspace",
+		Long:        "This command does not have full parity with the standard SSH command. For users who need the full functionality of SSH, create an ssh configuration with `coder config-ssh`.",
 		Middleware: serpent.Chain(
 			serpent.RequireNArgs(1),
 			r.InitClient(client),

cli/testdata/coder_ssh_--help.golden

@@ -5,6 +5,10 @@ USAGE:
 
   Start a shell into a workspace
 
+  This command does not have full parity with the standard SSH command. For
+  users who need the full functionality of SSH, create an ssh configuration with
+  `coder config-ssh`.
+
 OPTIONS:
       --disable-autostart bool, $CODER_SSH_DISABLE_AUTOSTART (default: false)
           Disable starting the workspace automatically when connecting via SSH.