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

📝 Source Google Search Console: update documentation #22295

Merged
merged 5 commits into from
Mar 21, 2023

Conversation

dictcp
Copy link
Contributor

@dictcp dictcp commented Feb 2, 2023

What

Fix #19343
Update documentation for Google Search Console integration, to make setup more smoothly and less troubleshooting.

How

  • Add more prerequisites
  • Give another meaningful example input in Setup UI

Recommended reading order

N/A

🚨 User Impact 🚨

N/A

Pre-merge Checklist

N/A

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

@CLAassistant
Copy link

CLAassistant commented Feb 2, 2023

CLA assistant check
All committers have signed the CLA.

@dictcp dictcp force-pushed the gsc-docs branch 2 times, most recently from 21a83b4 to 5893a3d Compare February 7, 2023 03:26
@dictcp dictcp changed the title update docs for Google Search Console integration Source Google Search Console: update documentation Feb 7, 2023
@dictcp dictcp changed the title Source Google Search Console: update documentation 📝 Source Google Search Console: update documentation Feb 7, 2023
@dictcp dictcp closed this Feb 7, 2023
@dictcp dictcp reopened this Feb 7, 2023
@garrrikkotua
Copy link

@dictcp your updates really helped me, thanks a lot! Thes should be added in the docs, especially about sc-domain part

@marcosmarxm
Copy link
Member

marcosmarxm commented Mar 21, 2023

/publish connector=connectors/source-google-search-console

🕑 Publishing the following connectors:
connectors/source-google-search-console
https://github.com/airbytehq/airbyte/actions/runs/4474327911


Connector Did it publish? Were definitions generated?
connectors/source-google-search-console

if you have connectors that successfully published but failed definition generation, follow step 4 here ▶️

Copy link
Collaborator

@lazebnyi lazebnyi left a comment

Choose a reason for hiding this comment

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

LGTM.

@marcosmarxm marcosmarxm merged commit 7696b30 into airbytehq:master Mar 21, 2023
erohmensing pushed a commit that referenced this pull request Mar 22, 2023
* update docs for Google Search Console integration

* update connector version

* bump connector version to 0.1.22

* auto-bump connector version

---------

Co-authored-by: marcosmarxm <marcosmarxm@gmail.com>
Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com>
Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
erohmensing pushed a commit that referenced this pull request Mar 22, 2023
* update docs for Google Search Console integration

* update connector version

* bump connector version to 0.1.22

* auto-bump connector version

---------

Co-authored-by: marcosmarxm <marcosmarxm@gmail.com>
Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com>
Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Google Search Console - Service Account Key Authentication Failure
6 participants