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

Update "Building a connector the hard way" doc #9008

Merged
merged 4 commits into from
Dec 21, 2021

Conversation

edgao
Copy link
Contributor

@edgao edgao commented Dec 21, 2021

What

Update docs for clarity and correctness

How

  • Clarify that the sorting is only to make it easier for the user to verify correctness, and that this is unnecessary for production connectors
  • Add the AIRBYTE_ENTRYPOINT env var, which is required for the standard acceptance tests to pass

Recommended reading order

First commit is pure whitespace. Next two commits are the interesting ones.

@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Dec 21, 2021
@edgao edgao temporarily deployed to more-secrets December 21, 2021 17:38 Inactive
@edgao edgao force-pushed the edgao/connector-the-hard-way branch from 8901a38 to 512bd22 Compare December 21, 2021 18:29
@edgao edgao temporarily deployed to more-secrets December 21, 2021 18:30 Inactive
@edgao edgao changed the title Clarify "Building a connector the hard way" doc Update "Building a connector the hard way" doc Dec 21, 2021
@edgao edgao marked this pull request as ready for review December 21, 2021 18:31
@@ -836,7 +836,7 @@ A full connector in less than 200 lines of code. Not bad! We're now ready to pac

Our connector is very lightweight, so the Dockerfile needed to run it is very light as well. We edit the autogenerated `Dockerfile` so that its contents are as followed:

```text
```Dockerfile
Copy link
Contributor

Choose a reason for hiding this comment

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

FWIW if gitbook doesn't show know what Dockerfile is supposed to do it might format it completely incorrectly. This isn't displayed on gitbook so no issues for now.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yay markdown. at the very least vscode and github both display this correctly, so 🤞

@sherifnada
Copy link
Contributor

also @edgao fwiw if there are portions of the PR template which are irrelevant (e.g: customer impact or checklist in this case) you can delete them to reduce visual clutter

Co-authored-by: Sherif A. Nada <[email protected]>
@edgao edgao temporarily deployed to more-secrets December 21, 2021 18:50 Inactive
@edgao edgao merged commit d0f9aa8 into master Dec 21, 2021
@edgao edgao deleted the edgao/connector-the-hard-way branch December 21, 2021 18:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants