From 066adec3e6a736204b81515363fdcc285902e442 Mon Sep 17 00:00:00 2001
From: Marius Kimmina <38843153+mariuskimmina@users.noreply.github.com>
Date: Tue, 17 Oct 2023 11:15:23 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=A7=B9=20add=20help=20to=20atlassian=20pr?=
 =?UTF-8?q?ovider=20(#2267)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* 🧹 add help to atlassian provider

---------

Signed-off-by: Marius Kimmina <mar.kimmina@gmail.com>
Co-authored-by: Christoph Hartmann <chris@lollyrock.com>
---
 .github/actions/spelling/expect.txt  |  1 +
 providers/atlassian/config/config.go | 25 ++++++++++++++++++++++---
 2 files changed, 23 insertions(+), 3 deletions(-)

diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt
index 5233695cf1..0410ecda13 100644
--- a/.github/actions/spelling/expect.txt
+++ b/.github/actions/spelling/expect.txt
@@ -13,6 +13,7 @@ cryptokey
 customresources
 datapath
 Ddos
+DIRECTORYID
 dfw
 dlq
 ekm
diff --git a/providers/atlassian/config/config.go b/providers/atlassian/config/config.go
index dd2fa79681..4756f07ce7 100644
--- a/providers/atlassian/config/config.go
+++ b/providers/atlassian/config/config.go
@@ -21,9 +21,28 @@ var Config = plugin.Provider{
 	},
 	Connectors: []plugin.Connector{
 		{
-			Name:      "atlassian",
-			Use:       "atlassian",
-			Short:     "Atlassian",
+			Name:  "atlassian",
+			Use:   "atlassian",
+			Short: "Atlassian",
+			Long: `atlassian is designed for querying resources within Atlassian Cloud, including Jira, Confluence, and SCIM.
+
+Available Commands:
+  admin                     Specifies the Atlassian admin to interact with.
+  jira                      Specifies the Jira instance to interact with.
+  confluence                Specifies the Confluence instance to interact with.
+  scim                      Specifies the SCIM instance to interact with.
+
+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, 
+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.
+`,
 			MaxArgs:   2,
 			Discovery: []string{},
 			Flags: []plugin.Flag{