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 Amazon S3: Fix docs link issue #14397

Merged
merged 4 commits into from
Jul 8, 2022

Conversation

lazebnyi
Copy link
Collaborator

@lazebnyi lazebnyi commented Jul 4, 2022

What

Fix link in docs

How

Fix name of section in docs

Pre-merge Checklist

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

@github-actions github-actions bot added area/connectors Connector related issues area/documentation Improvements or additions to documentation labels Jul 4, 2022
@lazebnyi lazebnyi temporarily deployed to more-secrets July 4, 2022 18:06 Inactive
@lazebnyi lazebnyi linked an issue Jul 4, 2022 that may be closed by this pull request
@lazebnyi lazebnyi requested a review from Phlair July 4, 2022 18:08
@lazebnyi lazebnyi marked this pull request as ready for review July 4, 2022 18:08
@lazebnyi lazebnyi temporarily deployed to more-secrets July 4, 2022 18:09 Inactive
@Phlair
Copy link
Contributor

Phlair commented Jul 5, 2022

@lazebnyi Couple of Qs:

  • Does this have the potential to break existing connections because of the name change? I'm genuinely not sure so hoping you've tested that.
  • What's the motivation behind this change? This connector can actually be used for non-Amazon S3 compatible storage, so it seems incorrect to call it Amazon S3...

@lazebnyi
Copy link
Collaborator Author

lazebnyi commented Jul 5, 2022

@Phlair

  1. Changes doesn't break existing connections. Tested locally.
  2. Agree with you. For my side I think S3 name for the connector is ok. So, @misteryeo could you approve that we can leave S3 and close issue?

@misteryeo
Copy link
Contributor

Thanks for the clarification on this - wasn't aware.

The problem I was trying to tackle here is that we've come across users who type 'Amazon' expecting to surface 'S3'. I imagine that we'll start seeing folks type 'Minio' and not be able to find anything either. This would apply for both the source and destination.

So the ideal situation here seems to be that the display name stays as 'S3' but we have some way of allowing search terms to surface this connector and those search terms being 'Amazon' and 'Minio'. What would it take for us to introduce this? cc: @sherifnada

@sherifnada
Copy link
Contributor

@misteryeo we need to add some notion of search terms to connectors. This is an OSS platform + Frontend change

@github-actions github-actions bot removed the area/connectors Connector related issues label Jul 7, 2022
@lazebnyi lazebnyi changed the title 🎉 Source Amazon S3: Fix UI connector name and link issue 🎉 Source Amazon S3: Fix docs link issue Jul 7, 2022
@lazebnyi
Copy link
Collaborator Author

lazebnyi commented Jul 7, 2022

@Phlair Reverted name to S3. Plz review.

Copy link
Contributor

@Phlair Phlair left a comment

Choose a reason for hiding this comment

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

👍

@lazebnyi lazebnyi merged commit f896c57 into master Jul 8, 2022
@lazebnyi lazebnyi deleted the lazebnyi/12163-fix-ui-name-and-link-issues branch July 8, 2022 12:13
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 connectors/source/s3
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update S3 connectors title to Amazon S3
5 participants