feat(docs): add connect-ui docs #3106

hassan254-prog · 2024-12-03T21:36:41Z

Describe the problem and your solution

Added connect-ui docs to

Compressed the screenshots

I was unable to gain access to some providers, including Affinity, Anrok, Brex, and Brightcrowd. Therefore, I created the -docs pages based on the providers' own documentation, including screenshots of the steps.

Follow-Up Question

@bodinsamuel, since we initially considered white and transparent backgrounds for the template logos due to Nango's black background, how do you suggest we handle this with the Connect UI?

linear · 2024-12-03T21:36:45Z

EXT-266 Add Connect UI documentation

khaliqgant · 2024-12-04T10:25:52Z

packages/shared/providers.yaml

@@ -585,13 +624,26 @@ aws-iam:
        retry:
            at: 'x-ratelimit-reset'
    docs: https://docs.nango.dev/integrations/all/aws
+    docs_connect: https://docs.nango.dev/integrations/all/avalara/connect


Suggested change

docs_connect: https://docs.nango.dev/integrations/all/avalara/connect

docs_connect: https://docs.nango.dev/integrations/all/aws/connect

khaliqgant

Looks like all the docs_connection links go to avalara. Can you fix the providers.yaml to link correctly?

bodinsamuel

Massive work 💪🏻
Could you make sure to split your PR a little more, because it's hard to read all of this and you have missed a few spots

docs-v2/integrations/all/brex-api-key/auth-token.png

bodinsamuel · 2024-12-04T10:32:22Z

docs-v2/integrations/all/brightcrowd.mdx

+## Going further
+
+<Card title="Connect to BrightCrowd" icon="link" href="/integrations/all/brightCrowd/connect" horizontal>


Suggested change

<Card title="Connect to BrightCrowd" icon="link" href="/integrations/all/brightCrowd/connect" horizontal>

<Card title="Connect to BrightCrowd" icon="link" href="/integrations/all/brightcrowd/connect" horizontal>

bodinsamuel · 2024-12-04T10:33:51Z

docs-v2/integrations/all/buildium/form.png

This could be great to reorder form when this happen, client ID is more logical at position 1

bodinsamuel · 2024-12-04T10:34:57Z

packages/shared/providers.yaml

@@ -1010,21 +1068,24 @@ builder-io-private:
        headers:
            Authorization: Bearer ${apiKey}
    docs: https://docs.nango.dev/integrations/all/builder-io
+    docs_connect: https://docs.nango.dev/integrations/all/avalara/connect


Suggested change

docs_connect: https://docs.nango.dev/integrations/all/avalara/connect

docs_connect: https://docs.nango.dev/integrations/all/brex/connect

bodinsamuel · 2024-12-04T10:35:20Z

packages/shared/providers.yaml

@@ -631,6 +683,7 @@ bamboohr-basic:
            method: GET
            endpoint: /v1/meta/fields
    docs: https://docs.nango.dev/integrations/all/bamboohr
+    docs_connect: https://docs.nango.dev/integrations/all/avalara/connect


Suggested change

docs_connect: https://docs.nango.dev/integrations/all/avalara/connect

docs_connect: https://docs.nango.dev/integrations/all/bamboohr/connect

bodinsamuel · 2024-12-04T10:38:27Z

packages/shared/providers.yaml

@@ -1134,6 +1202,7 @@ cal-com-v2:
            description: The API key for your Cal.com account
            pattern: '^cal_[a-zA-Z0-9_]+$'
            example: cal_xxxxxx
+            doc_section: '#step-1-finding-your-api-key'


missing docs_connect

bodinsamuel · 2024-12-04T10:38:36Z

packages/shared/providers.yaml

@@ -1107,6 +1174,7 @@ cal-com-v1:
            description: The API key for your Cal.com account
            pattern: '^cal_[a-zA-Z0-9_]+$'
            example: cal_xxxxxx
+            doc_section: '#step-1-finding-your-api-key'


missing docs_connect

bodinsamuel · 2024-12-04T10:38:44Z

packages/shared/providers.yaml

@@ -1070,20 +1134,23 @@ buildium:
            method: GET
            endpoint: /v1/rentals
    docs: https://docs.nango.dev/integrations/all/buildium
+    docs_connect: https://docs.nango.dev/integrations/all/avalara/connect


Suggested change

docs_connect: https://docs.nango.dev/integrations/all/avalara/connect

docs_connect: https://docs.nango.dev/integrations/all/buildium/connect

bodinsamuel · 2024-12-04T10:39:00Z

packages/shared/providers.yaml

    credentials:
        apiKey:
            type: string
            title: API Key
            description: The API key for your Buildium account
            pattern: '^[A-Za-z0-9+/]+$'
            example: uOq2p+xlgpFdijfV/HqY+EvYpZKHRwlyhGuAVbJIxXs
+            doc_section: '#step-1-finding-your-api-key-and-client-id'


would be better to split the steps

bodinsamuel · 2024-12-04T10:39:21Z

packages/shared/providers.yaml

@@ -1038,21 +1099,24 @@ builder-io-public:
        query:
            apiKey: ${apiKey}
    docs: https://docs.nango.dev/integrations/all/builder-io
+    docs_connect: https://docs.nango.dev/integrations/all/avalara/connect


Suggested change

docs_connect: https://docs.nango.dev/integrations/all/avalara/connect

docs_connect: https://docs.nango.dev/integrations/all/builder-io/connect

bodinsamuel · 2024-12-04T10:49:17Z

@bodinsamuel, since we initially considered white and transparent backgrounds for the template logos due to Nango's black background, how do you suggest we handle this with the Connect UI?

I'm not sure I understand the question

hassan254-prog · 2024-12-04T11:43:27Z

@bodinsamuel is it good to separate the connect-ui doc pages to the specific provider name, when we may have multiple providers within the providers.yaml? i.e
aws and aws-iam
can we have a separate doc pages for aws-iam only?

docs_connect: https://docs.nango.dev/integrations/all/aws-iam/connect

or we can consolidate all within the same doc pages

docs_connect: https://docs.nango.dev/integrations/all/aws/connect

We might encounter a provider with auth_modes that require the connect-ui. I wanted to clarify how we should proceed in such cases.

hassan254-prog · 2024-12-04T11:49:43Z

@bodinsamuel, since we initially considered white and transparent backgrounds for the template logos due to Nango's black background, how do you suggest we handle this with the Connect UI?

I'm not sure I understand the question

Below are screenshots for Canny. Notice how it is not visible on the connect-ui form.

bodinsamuel · 2024-12-04T13:18:58Z

is it good to separate the connect-ui

Yes we should actually. The guides should be as precise as possible.
On the opposite some guides could be duplicated (e.g: maybe some alias, staging, etc.) I think symlink could work in that case.

bodinsamuel · 2024-12-04T13:20:07Z

Below are screenshots for Canny. Notice how it is not visible on the connect-ui form.

ah good point. Yes I noticed that, I honestly don't ahah Maybe there is css/svg trick to reverse the color if the bg is white, I'll look into it

…ation

hassan254-prog · 2024-12-04T21:49:35Z

is it good to separate the connect-ui

Yes we should actually. The guides should be as precise as possible. On the opposite some guides could be duplicated (e.g: maybe some alias, staging, etc.) I think symlink could work in that case.

I have consolidated them, but the recent changes with 3109 are making yaml checks to fail. A good example is avalara which has a sandbox provider as well.

My thought was, we can consolidate all in the same connect doc page and have symbolic links within the same connect doc, that way we can link it to the providers.yaml.

Just an example;
in provider.yaml we can have ;

brex-api-key:
brex-basic:

Then we can have a single brex connect docs with grouped symbolic link for both in same doc

nango/docs-v2/integrations/all/brex/connect.mdx -> in here we can have

###Brex API Key
#### Step 1: Finding Your API key
#### Step 2:  Enter credentials in the Connect UI

###Brex BASIC
#### Step 1: Obtaining your credentials
#### Step 2:  Enter Basic credentials in the Connect UI

This way we can prevent a huge list of connect-ui directories and pages. What do you think?

feat(docs): add connect-ui docs

a23894d

hassan254-prog self-assigned this Dec 3, 2024

hassan254-prog requested a review from a team December 3, 2024 21:37

hassan254-prog marked this pull request as draft December 3, 2024 21:43

fix validation

cc84819

hassan254-prog marked this pull request as ready for review December 3, 2024 21:54

khaliqgant reviewed Dec 4, 2024

View reviewed changes

khaliqgant requested changes Dec 4, 2024

View reviewed changes

bodinsamuel reviewed Dec 4, 2024

View reviewed changes

review

5d4bc44

Hassan Wari and others added 3 commits December 5, 2024 00:04

review

3e3ac98

fix

fd1ad71

Merge branch 'master' into kelvinwari/ext-266-add-connect-ui-document…

5359930

…ation

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(docs): add connect-ui docs #3106

feat(docs): add connect-ui docs #3106

hassan254-prog commented Dec 3, 2024

linear bot commented Dec 3, 2024

khaliqgant Dec 4, 2024

khaliqgant left a comment

bodinsamuel left a comment

bodinsamuel Dec 4, 2024

bodinsamuel Dec 4, 2024

bodinsamuel Dec 4, 2024

bodinsamuel Dec 4, 2024

bodinsamuel Dec 4, 2024

bodinsamuel Dec 4, 2024

bodinsamuel Dec 4, 2024

bodinsamuel Dec 4, 2024

bodinsamuel Dec 4, 2024

bodinsamuel commented Dec 4, 2024

hassan254-prog commented Dec 4, 2024

hassan254-prog commented Dec 4, 2024

bodinsamuel commented Dec 4, 2024

bodinsamuel commented Dec 4, 2024

hassan254-prog commented Dec 4, 2024

	docs_connect: https://docs.nango.dev/integrations/all/avalara/connect
	docs_connect: https://docs.nango.dev/integrations/all/aws/connect

		## Going further

		<Card title="Connect to BrightCrowd" icon="link" href="/integrations/all/brightCrowd/connect" horizontal>

feat(docs): add connect-ui docs #3106

Are you sure you want to change the base?

feat(docs): add connect-ui docs #3106

Conversation

hassan254-prog commented Dec 3, 2024

Describe the problem and your solution

Follow-Up Question

linear bot commented Dec 3, 2024

Choose a reason for hiding this comment

khaliqgant left a comment

Choose a reason for hiding this comment

bodinsamuel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bodinsamuel commented Dec 4, 2024

hassan254-prog commented Dec 4, 2024

hassan254-prog commented Dec 4, 2024

bodinsamuel commented Dec 4, 2024

bodinsamuel commented Dec 4, 2024

hassan254-prog commented Dec 4, 2024