Updat the help text with consistent provider descriptions (#4028)

Right now it's all over the place and we're not describing the actual things we scan within these larger technologies properly Signed-off-by: Tim Smith <[email protected]>
mondoohq · May 20, 2024 · 8453617 · 8453617
1 parent d976b36
commit 8453617
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 15 deletions.
diff --git a/providers-sdk/v1/util/version/version.go b/providers-sdk/v1/util/version/version.go
@@ -7,7 +7,6 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
-	"go.mondoo.com/cnquery/v11/utils/stringx"
 	"go/format"
 	"os"
 	"os/exec"
@@ -17,6 +16,8 @@ import (
 	"strings"
 	"time"
 
+	"go.mondoo.com/cnquery/v11/utils/stringx"
+
 	mastermind "github.com/Masterminds/semver"
 	tea "github.com/charmbracelet/bubbletea"
 	"github.com/go-git/go-git/v5"
@@ -42,15 +43,15 @@ push it to a new branch.
 
   $ version update providers/*/ --increment=patch --commit
 
-The tool will also check if the provider go dependencies have changed since the 
+The tool will also check if the provider go dependencies have changed since the
 last version and will suggest to update them as well. To just clean up the go.mod
 and go.sum files, run:
 
-  $ version mod-tidy providers/*/ 
+  $ version mod-tidy providers/*/
 
 To update all provider go dependencies to the latest patch version, run:
 
-  $ version mod-update providers/*/ --patch 
+  $ version mod-update providers/*/ --patch
 
 To update all provider go dependencies to the latest version, run:
 

diff --git a/providers/atlassian/config/config.go b/providers/atlassian/config/config.go
@@ -23,7 +23,7 @@ var Config = plugin.Provider{
 		{
 			Name:  "atlassian",
 			Use:   "atlassian",
-			Short: "Atlassian",
+			Short: "an Atlassian Cloud Jira, Confluence or Bitbucket instance",
 			Long: `atlassian is designed for querying resources within Atlassian Cloud, including Jira, Confluence, and SCIM.
 
 Available Commands:
@@ -32,13 +32,13 @@ Available Commands:
   confluence                Specifies the Confluence instance to interact with.
   scim                      Specifies the SCIM instance to interact with.
 
-Examples: 
+Examples:
   cnquery shell atlassian admin --admin-token <token>
   cnquery shell atlassian jira --host <host> --user <user> --user-token <token>
   cnquery shell atlassian confluence --host <host> --user <user> --user-token <token>
   cnquery shell atlassian scim <directory-id> --scim-token <token>
 
-If the ATLASSIAN_ADMIN_TOKEN environment variable is set, the admin-token flag is not required. If the ATLASSIAN_USER, 
+If the ATLASSIAN_ADMIN_TOKEN environment variable is set, the admin-token flag is not required. If the ATLASSIAN_USER,
 ATLASSIAN_HOST, and ATLASSIAN_USER_TOKEN environment variables are set, the user, host, and user-token flags are not required.
 
 For SCIM, you receive both the token and the directory-id from Atlassian when you setup an identity provider.

diff --git a/providers/defaults.go b/providers/defaults.go
@@ -35,7 +35,7 @@ var DefaultProviders Providers = map[string]*Provider{
 				{
 					Name:  "atlassian",
 					Use:   "atlassian",
-					Short: "Atlassian",
+					Short: "an Atlassian Cloud Jira, Confluence or Bitbucket instance",
 				},
 			},
 		},
@@ -104,7 +104,7 @@ var DefaultProviders Providers = map[string]*Provider{
 				{
 					Name:  "gcp",
 					Use:   "gcp",
-					Short: "a Google Cloud project",
+					Short: "a Google Cloud project or folder",
 				},
 			},
 		},
@@ -239,7 +239,7 @@ var DefaultProviders Providers = map[string]*Provider{
 				{
 					Name:  "okta",
 					Use:   "okta",
-					Short: "Okta",
+					Short: "an Okta organization",
 				},
 			},
 		},

diff --git a/providers/gcp/config/config.go b/providers/gcp/config/config.go
@@ -23,7 +23,7 @@ var Config = plugin.Provider{
 		{
 			Name:    "gcp",
 			Use:     "gcp",
-			Short:   "a Google Cloud project",
+			Short:   "a Google Cloud project or folder",
 			MaxArgs: 2,
 			Discovery: []string{
 				resources.DiscoveryAll,

diff --git a/providers/mock.go b/providers/mock.go
@@ -22,7 +22,7 @@ var mockProvider = Provider{
 			{
 				Name:  "mock",
 				Use:   "mock",
-				Short: "use a recording without an active connection",
+				Short: "a recording file without an active connection",
 			},
 			{
 				Name:     "upstream",

diff --git a/providers/okta/config/config.go b/providers/okta/config/config.go
@@ -17,7 +17,7 @@ var Config = plugin.Provider{
 		{
 			Name:      "okta",
 			Use:       "okta",
-			Short:     "Okta",
+			Short:     "an Okta organization",
 			Discovery: []string{},
 			Flags: []plugin.Flag{
 				{

diff --git a/test/commands/testdata/cnquery_run.ct b/test/commands/testdata/cnquery_run.ct
@@ -6,7 +6,7 @@ Usage:
   cnquery run [command]
 
 Available Commands:
-  mock        Run a query with use a recording without an active connection
+  mock        Run a query with a recording file without an active connection
 
 Flags:
       --ast                  Parse the query and return the abstract syntax tree (AST).

diff --git a/test/commands/testdata/cnquery_scan.ct b/test/commands/testdata/cnquery_scan.ct
@@ -14,7 +14,7 @@ Usage:
   cnquery scan [command]
 
 Available Commands:
-  mock        Scan use a recording without an active connection
+  mock        Scan a recording file without an active connection
 
 Flags:
       --annotation stringToString     Add an annotation to the asset. (default [])