Skip to content
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

Merged
merged 39 commits into from
Nov 14, 2024
Merged

Conversation

dannylwe
Copy link
Contributor

Describe your changes

Issue ticket number and link

Checklist before requesting a review (skip if just adding/editing APIs & templates)

  • I added tests, otherwise the reason is:
  • I added observability, otherwise the reason is:
  • I added analytics, otherwise the reason is:

Copy link

linear bot commented Nov 12, 2024

@@ -0,0 +1,55 @@
---
Copy link
Member

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

@khaliqgant
Copy link
Member

@dannylwe Similar to Algolia there should be a "Going further" link on the main integration page that links to the connect.mdx page

@dannylwe dannylwe force-pushed the daniellwetabe/ext-230-documentation-connect-ui branch from 6be80f7 to ef89a1b Compare November 13, 2024 12:21
@dannylwe dannylwe changed the title Daniellwetabe/ext 230 documentation connect UI docs: connect UI Nov 13, 2024
@dannylwe dannylwe marked this pull request as ready for review November 13, 2024 13:18
@khaliqgant khaliqgant requested a review from a team November 13, 2024 20:31
Copy link
Collaborator

@bodinsamuel bodinsamuel left a 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 a doc_section
  • For each credentials add a doc_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
Copy link
Collaborator

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)

Copy link
Collaborator

@TBonnin TBonnin left a 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:
Copy link
Collaborator

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:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To authenticate with Perimeter81, you need two key pieces of information:
To authenticate with Perimeter81, you need one key piece of information:

@dannylwe dannylwe requested a review from bodinsamuel November 14, 2024 14:59
Copy link
Collaborator

@bodinsamuel bodinsamuel left a 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

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'
Copy link
Collaborator

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

Copy link
Contributor Author

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.

Copy link
Collaborator

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

Copy link
Collaborator

@bodinsamuel bodinsamuel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💯

@khaliqgant khaliqgant enabled auto-merge (squash) November 14, 2024 18:31
@khaliqgant khaliqgant merged commit ff3daf9 into master Nov 14, 2024
20 checks passed
@khaliqgant khaliqgant deleted the daniellwetabe/ext-230-documentation-connect-ui branch November 14, 2024 20:35
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants