Skip to content

Conversation

teallarson
Copy link
Contributor

@teallarson teallarson commented Oct 10, 2025

What

Based on some customer feedback that our setup guides were a bit difficult to follow and they just wanted a one page step-by-step.

  • Adds a straight shooting one-page guide for folks embedding us into an existing application
  • Moves existing getting started guides that showcased demo applications into a "Tutorials" area

This does depend on https://github.com/airbytehq/sonar/pull/1049 being merged, which moves the Applications Token endpoint to the public Sonar API (another request from that customer!)

Copy link
Contributor

👋 Greetings, Airbyte Team Member!

Here are some helpful tips and reminders for your convenience.

Helpful Resources

PR Slash Commands

Airbyte Maintainers (that's you!) can execute the following slash commands on your PR:

  • /format-fix - Fixes most formatting issues.
  • /bump-version - Bumps connector versions.
    • You can specify a custom changelog by passing changelog. Example: /bump-version changelog="My cool update"
    • Leaving the changelog arg blank will auto-populate the changelog from the PR title.
  • /run-cat-tests - Runs legacy CAT tests (Connector Acceptance Tests)
  • /build-connector-images - Builds and publishes a pre-release docker image for the modified connector(s).
  • JVM connectors:
    • /update-connector-cdk-version connector=<CONNECTOR_NAME> - Updates the specified connector to the latest CDK version.
      Example: /update-connector-cdk-version connector=destination-bigquery
    • /bump-bulk-cdk-version type=patch changelog='foo' - Bump the Bulk CDK's version. type can be major/minor/patch.
  • Python connectors:
    • /poe connector source-example lock - Run the Poe lock task on the source-example connector, committing the results back to the branch.
    • /poe source example lock - Alias for /poe connector source-example lock.
    • /poe source example use-cdk-branch my/branch - Pin the source-example CDK reference to the branch name specified.
    • /poe source example use-cdk-latest - Update the source-example CDK dependency to the latest available version.

📝 Edit this welcome message.

- Move tutorial document paths to tutorials/ subdirectory
- Add new quickstart page to sidebar
- Add template-tags to sidebar that was previously missing
- Organize tutorials under a collapsible Tutorials category
- Fix README.md link to point to tutorials/prerequisites-setup.md
- Update image paths in tutorial markdown files to use ../assets/ instead of ./assets/
- Ensures all links and images resolve correctly after file reorganization
Copy link
Contributor

github-actions bot commented Oct 10, 2025

Deploy preview for airbyte-docs ready!

✅ Preview
https://airbyte-docs-jskauh7y0-airbyte-growth.vercel.app

Built with commit eb02400.
This pull request is being automatically deployed with vercel-action

Copy link
Contributor

@ian-at-airbyte ian-at-airbyte left a comment

Choose a reason for hiding this comment

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

LGTM! I left a few suggestions, none of which are blocking. Just things that popped into my head as I read.

The other linter also had a few suggestions. Good to accept but again, not blocking.

@teallarson teallarson merged commit b5d18c1 into master Oct 13, 2025
33 checks passed
@teallarson teallarson deleted the teal/quickstart branch October 13, 2025 13:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants