-
Notifications
You must be signed in to change notification settings - Fork 465
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
docs: connect UI #2974
docs: connect UI #2974
Conversation
@@ -0,0 +1,55 @@ | |||
--- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file and the others should go under trello-scim
6be80f7
to
ef89a1b
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have not read everything yet, looks good overall.
It's missing the most critical part though, it needs to be linked in the providers.yaml, you can follow Algolia example:
- Add docs_connect
- If present, for each
connection_config
add adoc_section
- For each
credentials
add adoc_section
Note: I haven't documented all credentials for Basic Auth, I think only Bamboo HR, freshdesh and jira were done but you get the idea.
Sorry about that, it's very recent so the process is not perfect yet 👌🏻
## Going further | ||
|
||
<Card title="Connect to Aircall-Basic" icon="link" href="/integrations/all/aircall-basic/connect" horizontal> | ||
Guide to connect to Aircall-Basic using Connect UI |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry it was a left over from me, Connect UI should be named Nango Connect (or just Connect)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm. I am assuming the instructions are correct.
One question though for @bastienbeurier @khaliqgant: Are we not worried about the UI of the providers changing and our guide to become obsolete eventually?
|
||
# Overview | ||
|
||
To authenticate with Bill, you need two key pieces of information: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
two key pieces
but the list below contains 4
|
||
# Overview | ||
|
||
To authenticate with Datadog, you need two key pieces of information: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To authenticate with Datadog, you need two key pieces of information: | |
To authenticate with Datadog, you need three key pieces of information: |
|
||
# Overview | ||
|
||
To authenticate with Miro, you need two key pieces of information: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To authenticate with Miro, you need two key pieces of information: | |
To authenticate with Miro, you need one key piece of information: |
|
||
# Overview | ||
|
||
To authenticate with Notion, you need two key pieces of information: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To authenticate with Notion, you need two key pieces of information: | |
To authenticate with Notion, you need one key piece of information: |
|
||
# Overview | ||
|
||
To authenticate with Perimeter81, you need two key pieces of information: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To authenticate with Perimeter81, you need two key pieces of information: | |
To authenticate with Perimeter81, you need one key piece of information: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another comments, it would be less painful to sync with @khaliqgant before. Maybe it's okay to merge as-is and fix the rest later
packages/shared/providers.yaml
Outdated
connection_config: | ||
node: | ||
type: string | ||
title: Node | ||
description: The node id to your Keeper account | ||
pattern: '^\d{15}$' | ||
example: '123435384338765' | ||
doc_section: '#step-1-finding-your-api-key-api-token-and-node-id' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A comment that applies for all markdown, it should be one section per entry so the doc_section is directly relevant and ordered by the field order, e.g:
- Step 1: find your node id
- Step 2: find your api key
NB: you can reorder fields based on what's more logical, here for example apiKey will be first because we put credentials first but it's more logical to put order: 1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A comment that applies for all markdown, it should be one section per entry so the doc_section is directly relevant and ordered by the field order, e.g:
Step 1: find your node id
Step 2: find your api key
this has been updated and should be in the correct order.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should try to optimize the png as much as we can, apparently mintlify is not doing it by default
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💯
Describe your changes
Issue ticket number and link
Checklist before requesting a review (skip if just adding/editing APIs & templates)