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

Audrey/gettingstartedwithairbyte #38167

Closed
wants to merge 4 commits into from
Closed

Audrey/gettingstartedwithairbyte #38167

wants to merge 4 commits into from

Conversation

Adorism
Copy link
Contributor

@Adorism Adorism commented May 13, 2024

What

This change proposes edits to the docs welcome page and the addition of a dedicated quickstart section that more clearly presents steps to deploy the Community OSS locally to Airbyte newcomers.

How

There is a Quickstart introduction that presents information on

  1. Preparation needed to install Airbyte
  2. Installation options depending on OS
  3. Troubleshooting resources
  • The installation instructions are parsed out between Mac vs other OS users to keep caveats for Mac users on it's own page, rendering the instructions less ambiguous for all users.
  • The 'Next Steps' page gives a very brief explanation of what is needed to configure a connection and goes on to direct new users to resources for exploring sources and destinations. This page concludes by sharing links to Airbyte's official tutorials and an Airbyte specific Udemy course.

Review guide

User Impact

This change is intended to make it easier for those exploring Airbyte OSS to install and run it for the first time. It also includes a disambiguating point to share the command for subsequently running the program.

As of now, there may be some unnecessary duplication of information at various points in the docs. This will be investigated through further consideration of common docs entry points because, depending on user behavior, some instances of repetition may be indispensable as they are supportive of newly engaged users.

Can this PR be safely reverted and rolled back?

  • YES 💚
  • NO ❌

Copy link

vercel bot commented May 13, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
airbyte-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 15, 2024 5:30pm

@CLAassistant
Copy link

CLAassistant commented May 13, 2024

CLA assistant check
All committers have signed the CLA.

@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label May 13, 2024
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.

None yet

3 participants