Fixed Major Violations by UX writing Audit of Jfrog CLI

artifactory/cli.go

@@ -3,11 +3,12 @@ package artifactory
 import (
 	"errors"
 	"fmt"
+	"os"
+	"strings"
+
 	"github.com/jfrog/jfrog-cli-artifactory/artifactory/commands/python"
 	"github.com/jfrog/jfrog-cli/docs/artifactory/cocoapodsconfig"
 	"github.com/jfrog/jfrog-cli/docs/artifactory/swiftconfig"
-	"os"
-	"strings"
 
 	"github.com/jfrog/jfrog-cli/utils/accesstoken"
 

docs/artifactory/gocommand/help.go

@@ -3,7 +3,7 @@ package gocommand
 var Usage = []string{"rt go <go arguments> [command options]"}
 
 func GetDescription() string {
-	return "Runs go."
+	return "Run go"
 }
 
 func GetArguments() string {

docs/artifactory/groupcreate/help.go

@@ -3,7 +3,7 @@ package groupcreate
 var Usage = []string{"rt gc <group name>"}
 
 func GetDescription() string {
-	return "Create new users group."
+	return "Create a new user group"
 }
 
 func GetArguments() string {

docs/artifactory/groupdelete/help.go

@@ -3,7 +3,7 @@ package groupdelete
 var Usage = []string{"rt gdel <group name>"}
 
 func GetDescription() string {
-	return "Delete a users group."
+	return "Delete a user group"
 }
 
 func GetArguments() string {

docs/artifactory/mvn/help.go

@@ -7,7 +7,7 @@ var Usage = []string{"rt mvn <goals and options> [command options]"}
 var EnvVar = []string{common.JfrogCliReleasesRepo, common.JfrogCliDependenciesDir}
 
 func GetDescription() string {
-	return "Run Maven build."
+	return "Run Maven build"
 }
 
 func GetArguments() string {

docs/artifactory/terraform/help.go

@@ -3,7 +3,7 @@ package terraformdocs
 var Usage = []string{"terraform <terraform arguments> [command options]"}
 
 func GetDescription() string {
-	return "Runs terraform "
+	return "Run Terraform"
 }
 
 func GetArguments() string {

docs/artifactory/transferconfig/help.go

@@ -3,7 +3,7 @@ package transferconfig
 var Usage = []string{"rt transfer-config [command options] <source-server-id> <target-server-id>"}
 
 func GetDescription() string {
-	return `Copy full Artifactory configuration from source Artifactory server to target Artifactory server.`
+	return `Copy the full configuration from a source Artifactory server to a target server`
 }
 
 func GetArguments() string {

docs/artifactory/twine/help.go

@@ -3,7 +3,7 @@ package twinedocs
 var Usage = []string{"twine <twine arguments> [command options]"}
 
 func GetDescription() string {
-	return "Runs twine "
+	return "Run twine"
 }
 
 func GetArguments() string {

docs/artifactory/usercreate/help.go

@@ -3,5 +3,5 @@ package usercreate
 var Usage = []string{"rt user-create <username> <password> <email>"}
 
 func GetDescription() string {
-	return "Create new user."
+	return "Create a new user"
 }

docs/artifactory/userscreate/help.go

@@ -3,5 +3,5 @@ package userscreate
 var Usage = []string{"rt uc --csv <users details file path>"}
 
 func GetDescription() string {
-	return "Create new users."
+	return "Create new users"
 }

docs/general/summary/help.go

@@ -3,5 +3,5 @@ package summary
 var Usage = []string{"gsm"}
 
 func GetDescription() string {
-	return `Generates a Summary of recorded CLI commands there were executed on the current machine. The report is generated in Markdown format and saved in the directory stored in the JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR environment variable.`
+	return `Generate a summary of recorded CLI commands that were executed on the current machine. The report is generated in Markdown format and saved in the directory stored in the JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR environment variable.`
 }

docs/plugin/publish/help.go

@@ -7,7 +7,7 @@ var Usage = []string{"plugin publish <plugin name> <plugin version>"}
 var EnvVar = []string{common.JfrogCliPluginsServer, common.JfrogCliPluginsRepo}
 
 func GetDescription() string {
-	return "Publishing a JFrog CLI plugin."
+	return "Publish a JFrog CLI plugin"
 }
 
 func GetArguments() string {

main.go

@@ -231,38 +231,38 @@ func getCommands() ([]cli.Command, error) {
 	cliNameSpaces := []cli.Command{
 		{
 			Name:        cliutils.CmdArtifactory,
-			Usage:       "Artifactory commands.",
+			Usage:       "Artifactory commands",
 			Subcommands: artifactory.GetCommands(),
 			Category:    commandNamespacesCategory,
 		},
 		{
 			Name:        cliutils.CmdMissionControl,
-			Usage:       "Mission Control commands.",
+			Usage:       "Mission Control commands",
 			Subcommands: missioncontrol.GetCommands(),
 			Category:    commandNamespacesCategory,
 		},
 		{
 			Name:        cliutils.CmdPipelines,
-			Usage:       "Pipelines commands.",
+			Usage:       "Pipelines commands",
 			Subcommands: pipelines.GetCommands(),
 			Category:    commandNamespacesCategory,
 		},
 		{
 			Name:        cliutils.CmdCompletion,
-			Usage:       "Generate autocomplete scripts.",
+			Usage:       "Generate autocomplete scripts",
 			Subcommands: completion.GetCommands(),
 			Category:    otherCategory,
 		},
 		{
 			Name:        cliutils.CmdPlugin,
-			Usage:       "Plugins handling commands.",
+			Usage:       "Plugin commands",
 			Subcommands: plugins.GetCommands(),
 			Category:    commandNamespacesCategory,
 		},
 		{
 			Name:        cliutils.CmdConfig,
 			Aliases:     []string{"c"},
-			Usage:       "Server configurations commands.",
+			Usage:       "Server configuration commands",
 			Subcommands: config.GetCommands(),
 			Category:    commandNamespacesCategory,
 		},
@@ -274,7 +274,7 @@ func getCommands() ([]cli.Command, error) {
 		},
 		{
 			Name:     cliutils.CmdOptions,
-			Usage:    "Show all supported environment variables.",
+			Usage:    "Show all supported environment variables",
 			Category: otherCategory,
 			Action: func(*cli.Context) {
 				fmt.Println(common.GetGlobalEnvVars())
@@ -437,15 +437,15 @@ func IntroCmd(_ *cli.Context) error {
 		return err
 	}
 	clientlog.Output()
-	clientlog.Output(coreutils.PrintTitle(fmt.Sprintf("Thank you for installing version %s of JFrog CLI! 🐸", cliutils.CliVersion)))
+	clientlog.Output(coreutils.PrintTitle(fmt.Sprintf("Thank you for installing JFrog CLI version %s 🐸", cliutils.CliVersion)))
 	var serverExists bool
 	serverExists, err = coreconfig.IsServerConfExists()
 	if serverExists || err != nil {
 		return err
 	}
 	clientlog.Output(coreutils.PrintTitle("So what's next?"))
 	clientlog.Output()
-	clientlog.Output(coreutils.PrintTitle("Authenticate with your JFrog Platform by running one of the following two commands:"))
+	clientlog.Output(coreutils.PrintTitle("Authenticate with your JFrog Platform by running one of the following commands:"))
 	clientlog.Output()
 	clientlog.Output("jf login")
 	clientlog.Output(coreutils.PrintTitle("or"))

main_test.go

@@ -407,7 +407,7 @@ func TestIntro(t *testing.T) {
 	defer setEnvCallBack()
 
 	runJfrogCli(t, "intro")
-	assert.Contains(t, buffer.String(), "Thank you for installing version")
+	assert.Contains(t, buffer.String(), "Thank you for installing JFrog CLI version")
 }
 
 func TestSurvey_NotDisplayedOnNonHelp(t *testing.T) {