feat(docs): Connect UI Documentation #3107
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
khaliqgant
reviewed
Dec 4, 2024
packages/shared/providers.yaml
Outdated
| credentials: | ||
| username: | ||
| type: string | ||
| title: username |
There was a problem hiding this comment.
Suggested change
| title: username | |
| title: Access Key |
khaliqgant
reviewed
Dec 4, 2024
packages/shared/providers.yaml
Outdated
| pattern: '^[a-zA-Z0-9-]+$' | ||
| password: | ||
| type: string | ||
| title: Password |
There was a problem hiding this comment.
Suggested change
| title: Password | |
| title: Access Key Secret |
…tion-priority-ordered
…tion-priority-ordered
…tion-priority-ordered
bodinsamuel
reviewed
Dec 6, 2024
There was a problem hiding this comment.
Huge 💪🏻 (Shipping 10 will make this review a bit complex, we talked with khaliq to improve this next time)
I haven't read everything, here some global feedback:
- Each field in the Connect UI should ideally be one section in the markdown
- Missing doc_section on every provider in providers.yaml
- Brand casing
- Section title consistency: "Finding your X" works well I think, but maybe we should decide on a guideline here
…tion-priority-ordered
…tion-priority-ordered
khaliqgant
approved these changes
Dec 9, 2024
…tion-priority-ordered
khaliqgant
deleted the
daniellwetabe/ext-279-connect-ui-documentation-priority-ordered
branch
hassan254-prog
pushed a commit
that referenced
this pull request
Dec 16, 2024
<!-- Describe the problem and your solution --> Add docs for: - gong - greenhouse-basic - hibob-service-user - klaviyo - lever-basic - marketo - personio - sage-intacct - woocommerce - workable - workday - zoominfo <!-- Issue ticket number and link (if applicable) --> <!-- Testing instructions (skip if just adding/editing providers) --> --------- Co-authored-by: Khaliq <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add docs for: