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

fix: datasource documentation link (#30169) #33123

Merged
merged 3 commits into from
May 3, 2024

Conversation

NilanshBansal
Copy link
Contributor

@NilanshBansal NilanshBansal commented May 2, 2024

Description

This PR fixes the link associated with Learn More button on the datasource page. Earlier, on clicking Learn More button, there was a hardcoded URL in the code, which redirected the users to documentation homepage.
With this change, the user will be redirected to the specific plugin page as now the URL configuration is consumed from the database field plugin.documentationLink

Fixes #30169

Automation

/ok-to-test tags="@tag.Datasource"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/8935729769
Commit: 03a263d
Cypress dashboard url: Click here!

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Copy link
Contributor

coderabbitai bot commented May 2, 2024

Walkthrough

Walkthrough

The change involves adding an import statement for a store module in the DBForm.tsx file. This alteration could be part of a broader effort to enhance state management or fix bugs related to data handling in the DataSource Editor component of the application.

Changes

File Change Summary
.../src/pages/Editor/DataSourceEditor/DBForm.tsx Added import store from "store"; to enhance state management.

Assessment against linked issues

Objective Addressed Explanation
Fix redirection of "Learn More" to appropriate documentation on datasource or IP whitelisting (#30169) The change does not address any redirection or link modification issues. It's solely an import addition, unrelated to content or hyperlink adjustments in the UI.

Possibly related issues


Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between ead13a9 and 03a263d.
Files selected for processing (1)
  • app/client/src/pages/Editor/DataSourceEditor/DBForm.tsx (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • app/client/src/pages/Editor/DataSourceEditor/DBForm.tsx

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@NilanshBansal NilanshBansal self-assigned this May 2, 2024
@github-actions github-actions bot added Activation - datasources issues related to activation projects Query & JS Pod Issues related to the query & JS Pod Bug Something isn't working Datasources Issues related to configuring datasource on appsmith Integrations Product Issues related to a specific integration Integrations Pod General Issues related to the Integrations Pod that don't fit into other tags. Low effort Takes 1-2 days Medium Issues that frustrate users due to poor UX Needs Triaging Needs attention from maintainers to triage Production labels May 2, 2024
@NilanshBansal
Copy link
Contributor Author

/build-deploy-preview skip-tests=true

Copy link

github-actions bot commented May 2, 2024

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/8919867188.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 33123.
recreate: .

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

app/client/src/pages/Editor/DataSourceEditor/DBForm.tsx Outdated Show resolved Hide resolved
Copy link

github-actions bot commented May 2, 2024

Deploy-Preview-URL: https://ce-33123.dp.appsmith.com

@NilanshBansal NilanshBansal added the ok-to-test Required label for CI label May 2, 2024
@NilanshBansal NilanshBansal requested review from rishabhrathod01 and sneha122 and removed request for ayushpahwa May 2, 2024 10:04
@NilanshBansal
Copy link
Contributor Author

NilanshBansal commented May 2, 2024

@sneha122 @rishabhrathod01 the dp will not show these buttons because of this LOC.
This change can be pulled locally and tested.

@NilanshBansal NilanshBansal added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 3, 2024
@sneha122
Copy link
Contributor

sneha122 commented May 3, 2024

@NilanshBansal Do you think we should write any automation test cases for this?

@NilanshBansal
Copy link
Contributor Author

@NilanshBansal Do you think we should write any automation test cases for this?

@sneha122 I am not sure if we should write automation tests for this because, the documentation URL is picked from the database, and the documentation link can change in the future.
For such scenarios, if we change the documentation link from the database, we would also have to update the test cases i.e. code level changes will need to be done for a non-code related change.
Also, going forward let's say we change the link from https://docs.appsmith.com to https://appsmith-docs.com, instead of doing any code-level or db changes, we can just add a redirection rule to our DNS settings without need for dev dependency.
But there are pros and cons to either of the approach.
cc: @sneha122 @rishabhrathod01

@rishabhrathod01
Copy link
Contributor

I am not sure if we should write automation tests for this because, the documentation URL is picked from the database, and the documentation link can change in the future.
For such scenarios, if we change the documentation link from the database, we would also have to update the test cases i.e. code level changes will need to be done for a non-code related change.
Also, going forward let's say we change the link from https://docs.appsmith.com/ to https://appsmith-docs.com/, instead of doing any code-level or db changes, we can just add a redirection rule to our DNS settings without need for dev dependency. But there are pros and cons to either approach.

IMO we shouldn't test the user education routes in the product. A regression test suite could have these but E2E tests should skip this.

@NilanshBansal NilanshBansal added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 3, 2024
Copy link
Contributor

@rishabhrathod01 rishabhrathod01 left a comment

Choose a reason for hiding this comment

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

LGTM

@NilanshBansal NilanshBansal merged commit d35dfc1 into release May 3, 2024
42 checks passed
@NilanshBansal NilanshBansal deleted the fix/issue-30169/fix-ds-documentation-url branch May 3, 2024 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Activation - datasources issues related to activation projects Bug Something isn't working Datasources Issues related to configuring datasource on appsmith Integrations Pod General Issues related to the Integrations Pod that don't fit into other tags. Integrations Product Issues related to a specific integration Low effort Takes 1-2 days Medium Issues that frustrate users due to poor UX Needs Triaging Needs attention from maintainers to triage ok-to-test Required label for CI Production Query & JS Pod Issues related to the query & JS Pod
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Learn more documentation on create datasource takes us to basic application setup documentation page
3 participants