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(connectors): add section about adding built-in connectors #1021

Merged
merged 7 commits into from
May 4, 2023

Conversation

jayjayjpg
Copy link
Contributor

@jayjayjpg jayjayjpg commented May 1, 2023

Description

Following our discussion on Slack, this is adding additional documentation around built-in connectors and how to add them to custom binaries.

Quick checks:

  • I have followed the Code Guidelines.
  • There is no other pull request for the same update/change.
  • I have written unit tests.
  • I have made sure that the PR is of reasonable size and can be easily reviewed.

Preview

Preview Link

@jayjayjpg jayjayjpg requested a review from a team as a code owner May 1, 2023 19:01
@jayjayjpg jayjayjpg force-pushed the jj/add-docs-for-builtins branch 4 times, most recently from 4d0eb20 to 1e51be3 Compare May 1, 2023 19:16
Copy link
Contributor

@maha-hajja maha-hajja left a comment

Choose a reason for hiding this comment

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

Thank you for taking the initiative with these super helpful instructions! lovely work

docs/connectors.md Outdated Show resolved Hide resolved
docs/connectors.md Outdated Show resolved Hide resolved
Copy link
Member

@lovromazgon lovromazgon left a comment

Choose a reason for hiding this comment

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

Thanks for your addition @jayjayjpg! The issue is that this document is supposed to be reworked altogether and moved to conduit.io (#1015). How important is it to get this in now?

Also, I'm thinking if it would make sense to have a separate page on conduit.io that just addresses compiling your own Conduit binary with custom built-in connectors?

docs/connectors.md Outdated Show resolved Hide resolved
docs/connectors.md Outdated Show resolved Hide resolved
docs/connectors.md Outdated Show resolved Hide resolved
@jayjayjpg
Copy link
Contributor Author

Also, I'm thinking if it would make sense to have a separate page on conduit.io that just addresses compiling your own Conduit binary with custom built-in connectors?

@lovromazgon I like the idea of having a dedicated page for this on conduit.io, too! Would it make sense to get this change in just for further reference until the documentation rework is completed and to add another page to the hosted conduit docs in a follow up?

This way, we'd already have some minimal documentation on this process for now in case the question about built-in connectors comes up again in the near future and we would still be able to dedicate more time on documenting this properly on conduit.io for the general audience

What do you and @simonl2002 think?

@simonl2002
Copy link
Member

@jayjayjpg yes, lets separate this work from the work to add information to the conduit site.

@jayjayjpg
Copy link
Contributor Author

@maha-hajja @lovromazgon Thank you for all the feedback! I just updated the branch with your suggestions, let me know what you think!

Copy link
Member

@lovromazgon lovromazgon left a comment

Choose a reason for hiding this comment

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

More or less just nitpicks, all-in-all looks good 👍

docs/connectors.md Outdated Show resolved Hide resolved
docs/connectors.md Outdated Show resolved Hide resolved
docs/connectors.md Outdated Show resolved Hide resolved
docs/connectors.md Outdated Show resolved Hide resolved
docs/connectors.md Outdated Show resolved Hide resolved
docs/connectors.md Outdated Show resolved Hide resolved
jayjayjpg and others added 4 commits May 3, 2023 17:58
Co-authored-by: Lovro Mažgon <lovro.mazgon@gmail.com>
Co-authored-by: Lovro Mažgon <lovro.mazgon@gmail.com>
Co-authored-by: Lovro Mažgon <lovro.mazgon@gmail.com>
Co-authored-by: Lovro Mažgon <lovro.mazgon@gmail.com>
@jayjayjpg jayjayjpg force-pushed the jj/add-docs-for-builtins branch 2 times, most recently from 06cb89c to 8e2c62b Compare May 3, 2023 16:24
@jayjayjpg jayjayjpg merged commit 07ce9bd into main May 4, 2023
4 checks passed
@jayjayjpg jayjayjpg deleted the jj/add-docs-for-builtins branch May 4, 2023 10:50
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.

None yet

4 participants