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 troubleshooting section and remove FAQ file #3902

Merged
merged 6 commits into from
Jun 8, 2021

Conversation

marcosmarxm
Copy link
Member

What

Adding new section to help users and us debugging problems.

How

Create section troubleshooting and add files based on our process: on deploy, setting new source, connection and upgrading.

Recommended reading order

  1. x.java
  2. y.python

Pre-merge Checklist

Expand the checklist which is relevant for this PR.

Connector checklist

  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • Secrets are annotated with airbyte_secret in output spec
  • Unit & integration tests added as appropriate (and are passing)
    • Community members: please provide proof of this succeeding locally e.g: screenshot or copy-paste acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • /test connector=connectors/<name> command as documented here is passing.
    • Community members can skip this, Airbyters will run this for you.
  • Code reviews completed
  • Credentials added to Github CI if needed and not already present. instructions for injecting secrets into CI.
  • Documentation updated
    • README
    • CHANGELOG.md
    • Reference docs in the docs/integrations/ directory.
  • Build is successful
  • Connector version bumped like described here
  • New Connector version released on Dockerhub by running the /publish command described here
  • No major blockers
  • PR merged into master branch
  • Follow up tickets have been created
  • Associated tickets have been closed & stakeholders notified

## **Can Airbyte support 2-way sync i.e. changes from A go to B and changes from B go to A?**

We actually do not support this right now. There are some details around how we handle schema and tables names that isn't going to work for you in the current iteration.
If you attempt to do a circular dependency between source and destination, you'll end up with the following
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this true? I feel like we mostly support this today. Where I think this breaks is our inconsistent type support.

docs/faq/data-loading.md Outdated Show resolved Hide resolved
Copy link
Contributor

@davinchia davinchia left a comment

Choose a reason for hiding this comment

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

Some comments on the content. Looks good once we clear those up.

Will leave the organisation/structure to @avaidyanatha !

Copy link
Contributor

@avaidyanatha avaidyanatha left a comment

Choose a reason for hiding this comment

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

Some comments, looks good for the most part!

docs/SUMMARY.md Outdated Show resolved Hide resolved
docs/SUMMARY.md Outdated Show resolved Hide resolved
docs/faq/data-loading.md Outdated Show resolved Hide resolved
docs/faq/data-loading.md Outdated Show resolved Hide resolved
docs/faq/getting-started.md Outdated Show resolved Hide resolved
docs/faq/getting-started.md Outdated Show resolved Hide resolved
docs/faq/getting-started.md Outdated Show resolved Hide resolved
Copy link
Contributor

@sherifnada sherifnada left a comment

Choose a reason for hiding this comment

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

just leaving a comment on phrasing that should be used throughout the docs but happy w Davin and Abhi's reviews

@@ -22,6 +22,13 @@ Once all this is done, Airbyte resumes your sync from where it left off.

We truly appreciate any contribution you make to help the community. Airbyte will become the open-source standard only if everybody participates.

## **Can Airbyte support 2-way sync i.e. changes from A go to B and changes from B go to A?**

We actually do not support this right now. There are some details around how we handle schema and tables names that isn't going to work for you in the current iteration.
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of saying "we" we should use "Airbyte" -- the emphasis should be on the product :)

Suggested change
We actually do not support this right now. There are some details around how we handle schema and tables names that isn't going to work for you in the current iteration.
We actually do not support this right now. There are some details around how we handle schema and tables names that isn't going to work for you in the current iteration.

@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Jun 8, 2021
@marcosmarxm marcosmarxm merged commit b414f69 into master Jun 8, 2021
@marcosmarxm marcosmarxm deleted the marcosmarxm/doc-trouble-section branch June 8, 2021 23:31
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.

None yet

4 participants