Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

minor edits to the short and long text strings #211

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cli/cmd/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ const (
var createCmd = &cobra.Command{
Use: commandCreate + " [list of file-path] [flags]",
Short: "Creates detectors based on configurations",
Long: `Creates detectors based on configurations specified by file path`,
Long: `Creates detectors based on a configuration specified by a file path`,
Run: func(cmd *cobra.Command, args []string) {
generate, _ := cmd.Flags().GetBool(generate)
if generate {
Expand Down
2 changes: 1 addition & 1 deletion cli/cmd/delete.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const commandDelete = "delete"
var deleteCmd = &cobra.Command{
Use: commandDelete + " [flags] [list of detectors]",
Short: "Deletes detectors",
Long: `Deletes detectors based on value, use "" to make sure the name is not matched with pwd lists'`,
Long: `Deletes detectors based on a specified value. Use "" to make sure the name does not match with pwd lists'`,
Run: func(cmd *cobra.Command, args []string) {
//If no args, display usage
if len(args) < 1 {
Expand Down
18 changes: 9 additions & 9 deletions cli/cmd/profile.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,18 @@ const (
//profilesCmd is main command for profile operations like list, create and delete
var profilesCmd = &cobra.Command{
Use: profileBaseCmdName + " [flags] [command] [sub command]",
Short: "profile is a collection of settings and credentials that you can apply to an esad command",
Long: ` A named profile is a collection of settings and credentials that you can apply to an ESAD command.
When you specify a profile to run a command, the settings and credentials are used to run that command.
You can specify a profile in an environment variable (ESAD_PROFILE) which essentially acts as the default profile for commands if default doesn't exists.
The ESAD CLI supports using any of multiple named profiles that are stored in the config and credentials files.`,
Short: "A profile is a collection of settings and credentials that you can apply to an ESAD command",
Long: `A named profile is a collection of settings and credentials that you can apply to an ESAD command.
When you specify a profile for a command, its settings and credentials are used to run that command.
To configure a default profile for commands, specify the default profile in an environment variable (ESAD_PROFILE).
The ESAD CLI supports using any of the multiple named profiles that are stored in the configuration and credential files.`,
}

//createProfilesCmd creates profile interactively by prompting for name (distinct), user, endpoint, password.
var createProfilesCmd = &cobra.Command{
Use: createNewProfileCmdName,
Short: "Create new named profile",
Long: `A named profile is a collection of settings and credentials that you can apply to an ESAD command.`,
Short: "Creates a new named profile",
Long: `A named profile is a collection of settings and credentials that you can apply to an ESAD command`,
Run: func(cmd *cobra.Command, args []string) {
createProfile()
},
Expand All @@ -59,8 +59,8 @@ var createProfilesCmd = &cobra.Command{
//deleteProfileCmd deletes list of profiles passed as an arguments, provided profiles are already exists.
var deleteProfileCmd = &cobra.Command{
Use: deleteNewProfileCmdName + " [list of profile names to be deleted]",
Short: "Delete named profiles",
Long: `Delete profile permanently from configuration files`,
Short: "Deletes named profiles",
Long: `Delete a profile permanently from the configuration files`,
Run: func(cmd *cobra.Command, args []string) {
//If no args, display usage
if len(args) < 1 {
Expand Down
4 changes: 2 additions & 2 deletions cli/cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ var endpoint string

var esadCmd = &cobra.Command{
Use: cliName,
Short: "CLI to interact with Anomaly Detection plugin in your ES cluster",
Long: `The ESAD Command Line Interface is a tool to manage your Anomaly Detection Plugin`,
Short: "Use the CLI to interact with the Anomaly Detection plugin in your ES cluster",
Long: `The ESAD CLI is a tool to manage your Anomaly Detection plugin`,
Version: pkg.VERSION,
}

Expand Down
4 changes: 2 additions & 2 deletions cli/cmd/start_stop.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ const (
//default input is name pattern, one can change this format to be id by passing --id flag
var startCmd = &cobra.Command{
Use: commandStart + " [flags] [list of detectors]",
Short: "Start detectors based on id or name pattern",
Long: `Start detectors based on pattern, use "" to make sure the name is not matched with pwd lists'`,
Short: "Start detectors based on an ID or name pattern",
Long: `Start detectors based on a pattern. Use "" to make sure the name does not match with pwd lists'`,
Run: func(cmd *cobra.Command, args []string) {
idStatus, _ := cmd.Flags().GetBool("id")
action := ad.StartAnomalyDetectorByNamePattern
Expand Down