-
Notifications
You must be signed in to change notification settings - Fork 1.9k
feat: docs link on connector creation #5447
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Greptile Summary
This PR introduces a reusable ConnectorDocsLink
component to provide documentation links throughout the connector creation flow. The change extracts the previously hardcoded documentation link from the credential creation screen and creates a dedicated component that can be used consistently across multiple locations.
The implementation adds three key changes:
- New ConnectorDocsLink component - A clean, reusable component that renders documentation links using the existing
getSourceDocLink
utility. It displays the text "Check out our docs for more info on configuring this connector" with proper styling and handles cases where no documentation is available. - Refactored CreateCredential component - Replaces the inline documentation link JSX with the new ConnectorDocsLink component, removing code duplication and improving maintainability.
- Enhanced AddConnectorPage - Adds the documentation link to form step 1 (connector configuration), ensuring users have access to help documentation during the main configuration phase, not just during credential creation.
This change improves the user experience by providing consistent access to connector documentation at multiple points in the setup flow, while following DRY principles and creating a single source of truth for documentation link rendering.
Confidence score: 5/5
- This PR is safe to merge with minimal risk as it only involves UI improvements and component refactoring
- Score reflects simple, well-structured changes that improve code reusability without affecting core functionality
- No files require special attention as the changes are straightforward component extractions and additions
3 files reviewed, 1 comment
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.
1 issue found across 3 files
Prompt for AI agents (all 1 issues)
Understand the root cause of the following 1 issues and fix them.
<file name="web/src/components/admin/connectors/ConnectorDocsLink.tsx">
<violation number="1" location="web/src/components/admin/connectors/ConnectorDocsLink.tsx:24">
target="_blank" is missing rel="noopener noreferrer", which is a security risk (reverse tabnabbing).</violation>
</file>
React with 👍 or 👎 to teach cubic. Mention @cubic-dev-ai
to give feedback, ask questions, or re-run the review.
Check out | ||
<a | ||
className="text-blue-600 hover:underline" | ||
target="_blank" |
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.
target="_blank" is missing rel="noopener noreferrer", which is a security risk (reverse tabnabbing).
Prompt for AI agents
Address the following comment on web/src/components/admin/connectors/ConnectorDocsLink.tsx at line 24:
<comment>target="_blank" is missing rel="noopener noreferrer", which is a security risk (reverse tabnabbing).</comment>
<file context>
@@ -0,0 +1,33 @@
+ Check out
+ <a
+ className="text-blue-600 hover:underline"
+ target="_blank"
+ href={docsLink}
+ >
</file context>
291920e
to
9c9bd71
Compare
Description
add docs link to the main connector creation page (previously only show on credential creation screen)
How Has This Been Tested?
[Describe the tests you ran to verify your changes]
Backporting (check the box to trigger backport action)
Note: You have to check that the action passes, otherwise resolve the conflicts manually and tag the patches.
Summary by cubic
Adds a docs link to the main connector creation page so users can access setup instructions earlier. Also consolidates docs link rendering into a reusable component.
New Features
Refactors