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

Update Connector Builder docs to reflect configuration UI additions #21129

Merged
merged 2 commits into from
Jan 6, 2023

Conversation

lmossman
Copy link
Contributor

@lmossman lmossman commented Jan 6, 2023

What

Update the connector builder docs to match the functionality of the configuration UI release.

@octavia-squidington-iv octavia-squidington-iv added the area/documentation Improvements or additions to documentation label Jan 6, 2023
@lmossman lmossman marked this pull request as ready for review January 6, 2023 20:00
@lmossman lmossman changed the title Update Connector Builder docs Update Connector Builder docs to reflect configuration UI additions Jan 6, 2023

If you haven't already, create a low-code connector module using the connector generator (see [this YAML tutorial for an example](tutorial/1-create-source.md)) using the name you'd like to use for your connector. For this section, let's assume our connector is called `exchange-rates`. After creating the connector, overwrite the contents of `airbyte-integrations/connectors/source-exchange-rates/source_exchange_rates/exchange_rates.yaml` with the YAML you created in the UI.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure why this diff is weird -- this wasn't actually removed

### Visit the connector builder
Once your Airbyte instance has started and you've moved past the initial setup screen, visit `http://localhost:8000/connector-builder`. You will be redirected to a URL of the form `localhost:8000/workspaces/<UUID>/connector-builder` where `<UUID>` is the ID automatically generated for your workspace by Airbyte. On this page you will find the connector builder UI. It should look like this:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed this because it no longer redirects when visiting the connector builder page

@lmossman lmossman requested a review from sherifnada January 6, 2023 20:19
@lmossman lmossman merged commit d414e3d into master Jan 6, 2023
@lmossman lmossman deleted the lmossman/update-connector-builder-docs branch January 6, 2023 21:01
jbfbell pushed a commit that referenced this pull request Jan 13, 2023
…21129)

* update connector builder docs for UI MVP release

* remove note about separately declaring schemas
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