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

📝 add docs for how to add normalization #21563

Merged
merged 3 commits into from
Jan 19, 2023

Conversation

pedroslopez
Copy link
Contributor

@pedroslopez pedroslopez commented Jan 18, 2023

What

Adding normalization (specially for new connectors) is kind of tricky - this documents it!

close #21264

@octavia-squidington-iv octavia-squidington-iv added the area/documentation Improvements or additions to documentation label Jan 18, 2023
@pedroslopez pedroslopez requested review from evantahler and a team January 18, 2023 23:05
Copy link
Contributor

@evantahler evantahler left a comment

Choose a reason for hiding this comment

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

Just some nits!

I guess explaining how to make a normalization image is out of scope for this doc.

docs/connector-development/README.md Outdated Show resolved Hide resolved
docs/connector-development/README.md Outdated Show resolved Hide resolved
@pedroslopez pedroslopez enabled auto-merge (squash) January 19, 2023 15:10
@pedroslopez pedroslopez merged commit 4991e95 into master Jan 19, 2023
@pedroslopez pedroslopez deleted the pedroslopez/docs-normalization branch January 19, 2023 15:11
xiaohansong pushed a commit that referenced this pull request Jan 20, 2023
* add docs

* add schema link

* update based on feedback
xiaohansong added a commit that referenced this pull request Feb 6, 2023
* api changes for writing discover catalog

* api changes

* format

* worker change 1

* change return type of the API to return catalogId

* worker to call api

* typo

* 🎉 Source GoogleSheets -  migrated SAT to strictness level (#21399)

* migrated SAT to strictness level

* fixed expected records

* revert file from another source

* changed extension to txt

* changed extension to txt

* 🐛Destination-Bigquery: Added an explicit error message if sync fails due to a config issue (#21144)

* [19998] Destination-Bigquery: Added an explicit error message in sync fails due to a config issue

* ci-connector-ops: split workflows(#21474)

* CI:  nightly build alpha sources and destinations (#21562)

* Revert "Change main class in strict-encrypt destination and bump versions on both destinations to keep them in sync (#21509)" (#21567)

This reverts commit 1d202d1.

* Fixes webhook updating logic (#21519)

* ci_credentials: disable tooling test run by tox (#21580)

* disable tox

* rename steps

* revert changes on experimental workflow

* do not install tox

* Revert "CI:  nightly build alpha sources and destinations (#21562)" (#21589)

This reverts commit 61f88f3.

* Security update of default docker images (#21407)

Because there is a lot of CVEs in those releases.

Co-authored-by: Topher Lubaway <[email protected]>

* 📝 add docs for how to add normalization (#21563)

* add docs

* add schema link

* update based on feedback

* 🪟 🚦  E2E tests: clean up matchers (#20887)

* improve serviceTypeDropdownOption selector

* add test ids to PathPopout component(s)

* add unique id's to table dropdowns

* extend submitButtonClick to support optional click options

* update dropdown(pathPopout) matchers

* add test-id to Overlay component

* remove redundant function brackets

* revert changes onSubmit button click

* fix dropDown overlay issue

* move all duplicated intercepters to beforeEach

* add test id's to Connections, Sources and Destinations tables

* add table helper functions

* update source page actions

* intercepter fixes

* update createTestConnection function with optional replication settings

* remove extra Connection name check

* replace "cypress-postgres" with "pg-promise" npm package

* update cypress config

* Revert "update createTestConnection function with optional replication settings"

This reverts commit 8e47c78.

* Revert "remove extra Connection name check"

This reverts commit dfb19c7.

* replace openSourceDestinationFromGrid with specific selector

* replace openSourceDestinationFromGrid with specific selector

* turn on test

* add test-id's

* fix selectors

* update test

* update test snapshots

* fix lost data-testid after resolve merge conflicts

* remove extra check

* move clickOnCellInTable helper to common.ts file

* remove empty line and comments

* fix dropdownType

* replace partial string check with exact

* extract interceptors and waiters to separate file

* fix selector for predefined PK

* fix selector

* add comment regarding dropdown

* 🪟 🎨 [Free connectors] Update modal copy (#21600)

* move start/end time options out of optional block (#21541)

* lingering fix

* reflecting api changes

* test fix

* worker to call api to do discover work

* recovered deleted html

* self review

* more converters refactor

* fix connector test

* fix test

* fix

* fix integration test

* add unit test for converter

* static fix

* api client needs to have a timeout in case request does not get responded

---------

Co-authored-by: midavadim <[email protected]>
Co-authored-by: Eugene <[email protected]>
Co-authored-by: Augustin <[email protected]>
Co-authored-by: Greg Solovyev <[email protected]>
Co-authored-by: Yatsuk Bogdan <[email protected]>
Co-authored-by: Hervé Commowick <[email protected]>
Co-authored-by: Topher Lubaway <[email protected]>
Co-authored-by: Pedro S. Lopez <[email protected]>
Co-authored-by: Vladimir <[email protected]>
Co-authored-by: Joey Marshment-Howell <[email protected]>
Co-authored-by: Lake Mossman <[email protected]>
xiaohansong added a commit that referenced this pull request Feb 7, 2023
* api changes for writing discover catalog

* api changes

* format

* worker change 1

* change return type of the API to return catalogId

* worker to call api

* typo

* 🎉 Source GoogleSheets -  migrated SAT to strictness level (#21399)

* migrated SAT to strictness level

* fixed expected records

* revert file from another source

* changed extension to txt

* changed extension to txt

* 🐛Destination-Bigquery: Added an explicit error message if sync fails due to a config issue (#21144)

* [19998] Destination-Bigquery: Added an explicit error message in sync fails due to a config issue

* ci-connector-ops: split workflows(#21474)

* CI:  nightly build alpha sources and destinations (#21562)

* Revert "Change main class in strict-encrypt destination and bump versions on both destinations to keep them in sync (#21509)" (#21567)

This reverts commit 1d202d1.

* Fixes webhook updating logic (#21519)

* ci_credentials: disable tooling test run by tox (#21580)

* disable tox

* rename steps

* revert changes on experimental workflow

* do not install tox

* Revert "CI:  nightly build alpha sources and destinations (#21562)" (#21589)

This reverts commit 61f88f3.

* Security update of default docker images (#21407)

Because there is a lot of CVEs in those releases.

Co-authored-by: Topher Lubaway <[email protected]>

* 📝 add docs for how to add normalization (#21563)

* add docs

* add schema link

* update based on feedback

* 🪟 🚦  E2E tests: clean up matchers (#20887)

* improve serviceTypeDropdownOption selector

* add test ids to PathPopout component(s)

* add unique id's to table dropdowns

* extend submitButtonClick to support optional click options

* update dropdown(pathPopout) matchers

* add test-id to Overlay component

* remove redundant function brackets

* revert changes onSubmit button click

* fix dropDown overlay issue

* move all duplicated intercepters to beforeEach

* add test id's to Connections, Sources and Destinations tables

* add table helper functions

* update source page actions

* intercepter fixes

* update createTestConnection function with optional replication settings

* remove extra Connection name check

* replace "cypress-postgres" with "pg-promise" npm package

* update cypress config

* Revert "update createTestConnection function with optional replication settings"

This reverts commit 8e47c78.

* Revert "remove extra Connection name check"

This reverts commit dfb19c7.

* replace openSourceDestinationFromGrid with specific selector

* replace openSourceDestinationFromGrid with specific selector

* turn on test

* add test-id's

* fix selectors

* update test

* update test snapshots

* fix lost data-testid after resolve merge conflicts

* remove extra check

* move clickOnCellInTable helper to common.ts file

* remove empty line and comments

* fix dropdownType

* replace partial string check with exact

* extract interceptors and waiters to separate file

* fix selector for predefined PK

* fix selector

* add comment regarding dropdown

* 🪟 🎨 [Free connectors] Update modal copy (#21600)

* move start/end time options out of optional block (#21541)

* lingering fix

* reflecting api changes

* test fix

* reset to master

* routing changes

* remove unexpected merge

* resolve dependency micronaut

* resolve dependency

* format

* fix test

* rename and refactor location of test files

* test

* redo the routing service

* add test to config repository

* query workspace not connection for discover/check

* remove unused bean

---------

Co-authored-by: midavadim <[email protected]>
Co-authored-by: Eugene <[email protected]>
Co-authored-by: Augustin <[email protected]>
Co-authored-by: Greg Solovyev <[email protected]>
Co-authored-by: Yatsuk Bogdan <[email protected]>
Co-authored-by: Hervé Commowick <[email protected]>
Co-authored-by: Topher Lubaway <[email protected]>
Co-authored-by: Pedro S. Lopez <[email protected]>
Co-authored-by: Vladimir <[email protected]>
Co-authored-by: Joey Marshment-Howell <[email protected]>
Co-authored-by: Lake Mossman <[email protected]>
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.

Document how to enable normalization for a new destination
3 participants