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

Fix incorrect code for Snowflake GCS documentation #7287

Merged
merged 1 commit into from
Oct 22, 2021

Conversation

bbugh
Copy link
Contributor

@bbugh bbugh commented Oct 22, 2021

What

In the Snowflake documentation for GCS, it had io_airbyte_test_staging which looks like a literal string and is not mentioned in the explanation above. Looks like it was just an oversight.

How

Fix the documentation

Related Slack support thread thread https://app.slack.com/client/T01AB4DDR2N/C01MFR03D5W/thread/C01MFR03D5W-1634852461.058400

Recommended reading order

I have no idea what this is 🤷🏻

  1. x.java
  2. y.python

Pre-merge Checklist

Expand the relevant checklist and delete the others.

None of the below? 🤷🏻

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/SUMMARY.md
    • 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
  • Connector added to connector index like described here

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
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command 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
  • Connector version bumped like described here

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
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub 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.

This was confusing, as `io_airbyte_test_staging` looks like a literal string and is not mentioned in the explanation above. Slack support context: https://app.slack.com/client/T01AB4DDR2N/C01MFR03D5W/thread/C01MFR03D5W-1634852461.058400
@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Oct 22, 2021
Copy link
Member

@marcosmarxm marcosmarxm left a comment

Choose a reason for hiding this comment

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

thanks @bbugh

@marcosmarxm marcosmarxm merged commit a9e01db into airbytehq:master Oct 22, 2021
schlattk pushed a commit to schlattk/airbyte that referenced this pull request Jan 4, 2022
This was confusing, as `io_airbyte_test_staging` looks like a literal string and is not mentioned in the explanation above. Slack support context: https://app.slack.com/client/T01AB4DDR2N/C01MFR03D5W/thread/C01MFR03D5W-1634852461.058400
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 community
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants