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

docs(CE): add managing connectors docs #434

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

Conversation

xyfer17
Copy link
Contributor

@xyfer17 xyfer17 commented Oct 23, 2024

Description

  • add managing connectors docs

Related Issue

Relates to issue #404

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • New Connector (Destination or Source Connector)
  • Breaking change (fix or feature that would impact existing functionality)
  • Styling change
  • Documentation update
  • Refactoring
  • Chore

Checklist:

  • Ensure a branch name is prefixed with feature, bugfix, hotfix, release, style or chore followed by / and branch name e.g feature/add-salesforce-connector
  • Added unit tests for the changes made (if required)
  • Have you made sure the commit messages meets the guidelines?
  • Added relevant screenshots for the changes
  • Added the new connector in rollout.rb
  • Have you updated the version number of the gem?
  • Have you tested the changes on local/staging?
  • Have you ensured that your changes for new connector are documented in the docs repo or relevant documentation files?
  • Have you updated the run time dependency in multiwoven-integrations.gemspec if new gems are added
  • Have you made sure the code you have written follows the best practises to the best of your knowledge?

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants