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.

Sign up for GitHub

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

docs(CE): add managing connectors docs #434

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(CE): add managing connectors docs #434

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 46 additions & 2 deletions README.md
View file
Open in desktop
Copy link

Choose a reason for hiding this comment

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

I don't think adding this information in the Readme provides much of a value add. The specific step required for each connector can be quite different and ideally we should provide specific information if it is missing in the product documentation. The Readme is meant to provide a high level overview.

Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,11 @@ Sync your data with destinations like Salesforce, HubSpot, Slack, and more.

## Table of Contents

- [Why Multiwoven?](#why-multiwoven)
- [Connect to sources](#connect-to-sources)
- [Prepare your data](#prepare-your-data)
- [Sync with destinations](#sync-with-destinations)
- [Table of Contents](#table-of-contents)
- [Getting Started](#getting-started)
- [Local Setup](#local-setup)
- [Self-hosted Options](#self-hosted-options)
Expand All @@ -110,11 +115,14 @@ Sync your data with destinations like Salesforce, HubSpot, Slack, and more.
- [Collaboration](#collaboration)
- [Analytics](#analytics)
- [Others](#others)
- [Managing Connectors](#managing-connectors)
- [Adding a Connector](#adding-a-connector)
- [Updating a Connector](#updating-a-connector)
- [Contributing](#contributing)
- [Need Help?](#need-help)
- [Development Status: Under Active Development](#️-development-status-under-active-development)
- [License](#license)
- [⚠️ Development Status: Under Active Development](#️-development-status-under-active-development)
- [Contributors](#contributors)
- [License](#license)

## Getting Started

Expand Down Expand Up @@ -246,6 +254,42 @@ Multiwoven can be deployed in a variety of environments, from fully managed clou

🧵...Weaving in more connectors to support a wide range of destinations.

## Managing Connectors

In Multiwoven, connectors allow you to sync data between your warehouse and external tools. Follow these steps to add or update connectors.

### Adding a Connector

1. **Select a Data Source/Destinations:**
Go to the **Connectors** section and choose the source or destination you want to add (e.g., Databricks, Salesforce).

2. **Enter Credential Details:**
Provide the required credentials like API keys or database connection strings.

3. **Test the Connection:**
Click the **Test Connection** button to ensure the credentials are valid and the connection works.

4. **Save the Source:**
Once the connection test is successful, click **Save** to finalize the setup.

---

### Updating a Connector

1. **Select the Data Source/Destinations:**
Find the existing connector in the **Connectors** section and open its configuration.

2. **Update Credential Details:**
Modify any outdated or incorrect credentials.

3. **Test the Connection:**
Verify the updated credentials by clicking **Test Connection**.

4. **Save the Changes:**
Click **Save the Changes** to store the updated configuration.

By following these steps, you can easily add or update connectors, ensuring smooth data syncing across platforms.

## Contributing

We ❤️ contributions and feedback! Help make Multiwoven better for everyone!
Expand Down