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

Document guidelines on low-code support #16387

Merged
merged 7 commits into from
Sep 7, 2022
Merged

Conversation

girarda
Copy link
Contributor

@girarda girarda commented Sep 7, 2022

What

Add guidelines to help developers know whether an integration can be built using low-code or not.

How

  • Add a series of questions with some examples

Recommended reading order

  1. docs/connector-development/config-based/overview.md

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user? If yes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and 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.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the connector is published, connector added to connector index as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here
Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and 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.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub and connector version bumped by running the /publish command described here
Connector Generator
  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Sep 7, 2022
@girarda girarda changed the title Guide for using lowcode or not Document guidelines on low-code support Sep 7, 2022
@girarda girarda marked this pull request as ready for review September 7, 2022 01:16
Copy link
Contributor

@brianjlai brianjlai left a comment

Choose a reason for hiding this comment

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

i like the references to various API docs to illustrate examples. docs look good to me!

Do you think its worth listing out which stream slicers are available in the language. Might not be as useful for determining if a new integrations is compatible, but when porting existing connectors over, some might perform slicing in unique ways making them incompatible

docs/connector-development/config-based/overview.md Outdated Show resolved Hide resolved
docs/connector-development/config-based/overview.md Outdated Show resolved Hide resolved
docs/connector-development/config-based/overview.md Outdated Show resolved Hide resolved
docs/connector-development/config-based/overview.md Outdated Show resolved Hide resolved
girarda and others added 5 commits September 7, 2022 08:21
Co-authored-by: Andy <andy@airbyte.io>
Co-authored-by: Andy <andy@airbyte.io>
Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>
Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>
@girarda girarda merged commit 4e7ba06 into master Sep 7, 2022
@girarda girarda deleted the alex/lowcodeGuidelines branch September 7, 2022 17:24
robbinhan pushed a commit to robbinhan/airbyte that referenced this pull request Sep 29, 2022
* Guide for using lowcode or not

* Use headers

* Update docs/connector-development/config-based/overview.md

Co-authored-by: Andy <andy@airbyte.io>

* Update docs/connector-development/config-based/overview.md

Co-authored-by: Andy <andy@airbyte.io>

* Update docs/connector-development/config-based/overview.md

Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>

* Update docs/connector-development/config-based/overview.md

Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>

* an -> a

Co-authored-by: Andy <andy@airbyte.io>
Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>
jhammarstedt pushed a commit to jhammarstedt/airbyte that referenced this pull request Oct 31, 2022
* Guide for using lowcode or not

* Use headers

* Update docs/connector-development/config-based/overview.md

Co-authored-by: Andy <andy@airbyte.io>

* Update docs/connector-development/config-based/overview.md

Co-authored-by: Andy <andy@airbyte.io>

* Update docs/connector-development/config-based/overview.md

Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>

* Update docs/connector-development/config-based/overview.md

Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>

* an -> a

Co-authored-by: Andy <andy@airbyte.io>
Co-authored-by: Brian Lai <51336873+brianjlai@users.noreply.github.com>
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.

3 participants