Skip to content

Commit

Permalink
Update Troubleshooting documentation (#26048)
Browse files Browse the repository at this point in the history
* remove unused docs and create troubleshooting main page

* add desc

* update our troubleshooting page

* add premium support mention

* update link to daily oh

* add notes of premium support in other pages

* remove ref in local deployment and sidebar
  • Loading branch information
marcosmarxm committed May 15, 2023
1 parent be6dbae commit d0fa40c
Show file tree
Hide file tree
Showing 12 changed files with 74 additions and 244 deletions.
3 changes: 3 additions & 0 deletions docs/connector-development/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,13 @@ To build a new connector in Java or Python, we provide templates so you don't ne

Airbyte provides some Connector Development Kits (CDKs) to help you build connectors.

If you need help from our team for connector development, we offer premium support to our open-source users, [talk to our team](https://airbyte.com/talk-to-sales-premium-support) to get access to it.

### Connector builder UI

The [connector builder UI](connector-builder-ui/overview.md) is based on the low-code development framework below and allows to develop and use connectors without leaving the Airbyte UI (no local development environment required).


### Low-code Connector-Development Framework

You can use the [low-code framework](config-based/low-code-cdk-overview.md) to build source connectors for REST APIs by modifying boilerplate YAML files.
Expand Down
2 changes: 1 addition & 1 deletion docs/deploying-airbyte/local-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ bash run-ab-platform.sh

## Troubleshooting

If you encounter any issues, just connect to our [Slack](https://slack.airbyte.io). Our community will help! We also have a [troubleshooting](../troubleshooting/on-deploying.md) section in our docs for common problems.
If you encounter any issues, just connect to our [Slack](https://slack.airbyte.io). Our community will help! We also have a [troubleshooting](../troubleshooting.md) section in our docs for common problems.
2 changes: 2 additions & 0 deletions docs/operator-guides/upgrading-airbyte.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ This tutorial will describe how to determine if you need to run this upgrade pro

When Airbyte is upgraded, it will attempt to upgrade some connector versions. It follows the following rules: 1. if a connector is not used, it will be upgraded to the latest version 2. if a connector is used, it will NOT be upgraded to avoid disrupting working workflows. If you want to upgrade a connector, do so in the settings page in the webapp.

If you need help from our team for your upgrades, we offer premium support to our open-source users, [talk to our team](https://airbyte.com/talk-to-sales-premium-support) to get access to it.

## Determining if you need to Upgrade

Airbyte intelligently performs upgrades automatically based off of your version defined in your `.env` file and will handle data migration for you.
Expand Down
2 changes: 2 additions & 0 deletions docs/quickstart/deploy-airbyte.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Once you see an Airbyte banner, the UI is ready to go at [http://localhost:8000]

Alternatively, if you have an Airbyte Cloud invite, just follow [these steps.](../deploying-airbyte/on-cloud.md)

If you need direct access to our team for any kind of assistance, don't hesitate to [talk to our team](https://airbyte.com/talk-to-sales-premium-support) to discuss about our premium support offers."

## FAQ

If you have any questions about the Airbyte Open-Source setup and deployment process, head over to our [Getting Started FAQ](https://discuss.airbyte.io/c/faq/15) on our Discourse that answers the following questions and more:
Expand Down
4 changes: 1 addition & 3 deletions docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@ Next, check out the [step-by-step tutorial](https://docs.airbyte.com/cloud/getti

Browse the [connector catalog](https://docs.airbyte.com/integrations/) to find the connector you want. If the connector is not yet supported on Airbyte Open Source, [build your own connector](https://docs.airbyte.com/connector-development/).

Next, check out the [Airbyte Open Source QuickStart](https://docs.airbyte.com/quickstart/deploy-airbyte). Then learn how to [deploy](https://docs.airbyte.com/deploying-airbyte/local-deployment) and [manage](https://docs.airbyte.com/operator-guides/upgrading-airbyte) Airbyte Open Source in your cloud infrastructure.

To get help with Airbyte deployments, check out the [Troubleshooting & FAQ](https://docs.airbyte.com/troubleshooting/), chat with Support on [Discourse](https://discuss.airbyte.io/), or join us on [Community Slack](https://slack.airbyte.io/).
Next, check out the [Airbyte Open Source QuickStart](https://docs.airbyte.com/quickstart/deploy-airbyte). Then learn how to [deploy](https://docs.airbyte.com/deploying-airbyte/local-deployment) and [manage](https://docs.airbyte.com/operator-guides/upgrading-airbyte) Airbyte Open Source in your cloud infrastructure.

### For Airbyte contributors

Expand Down
61 changes: 61 additions & 0 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Troubleshooting & FAQ

Welcome to the Airbyte troubleshooting guide! Like any platform, you may experience issues when using Airbyte. This guide is designed to help you diagnose and resolve any problems you may encounter while using Airbyte. By following the troubleshooting steps outlined in this guide, you can quickly and effectively identify the root cause of the issue and take steps to resolve it. We recommend checking this guide whenever you encounter an issue with Airbyte to help ensure a smooth and uninterrupted experience with our platform. Let's dive in!

Step 1: Check the logs. The logs provide detailed information about what's happening behind the scenes, and they can help pinpoint the root cause of the problem.

Step 2: Check the documentation. Our documentation covers a wide range of topics, including common issues and their solutions, troubleshooting tips, and best practices.

Step 3: Reach out to the community. Our community forum is a great place to ask for help, share your experiences, and learn from others who have faced similar issues.

Step 4: Open a Github ticket. If you're still unable to resolve the issue after reaching out to the community, it's time to open a support ticket. Our support team is here to help you with any issues you're facing with Airbyte.

Airbyte is an open source project with a vibrant community that fosters collaboration and mutual support. To ensure accessible troubleshooting guidance, Airbyte offers multiple platforms for users to ask and discuss issues, including the Airbyte Github, Airbyte Community Slack (which is over 10,000 users), and the Airbyte Forum. In addition, Airbyte hosts daily office hours that include topic demonstrations and dedicated space for issue discussion in Zoom meetings. In addition to these community resources, Airbyte also offers premium support packages for users who require additional assistance beyond what is provided by the community.

## OSS Premium Support
Open source [premium support packages](https://airbyte.com/talk-to-sales-premium-support) are a great option for who use Airbyte OSS and need additional assistance beyond what is provided by the community. These packages typically include access to a dedicated support team that can provide assistance with installation, configuration, troubleshooting, and other technical issues. Premium support packages also often include faster response times, guaranteed issue resolution, and access to updates and patches. By opting for a premium support package, users can enjoy the benefits of open source software while also receiving the peace of mind they need to keep their systems running smoothly.

Premier Support comes with:

* 1-business-day SLA for your Severity 0 and 1
* 2-business-day SLA for your Severity 2 and 3
* 1-week Pull Request review SLA for first comment
If you need better SLA times, we can definitely discuss this, don't hesitate to [talk to our team](https://airbyte.com/talk-to-sales) about it. You can also see more details about it in our pricing page.

## Office Hour
Airbyte provides a [Daily Office Hour](https://airbyte.com/daily-office-hour) to discuss issues.
It is a 45 minute meeting, the first 20 minutes are reserved to a weekly topic presentation about Airbyte concepts and the others 25 minutes are for general questions. The schedule is:
* Monday, Wednesday and Fridays: 1 PM PST/PDT
* Tuesday and Thursday: 4 PM CEST


## Github Issues
Whenever you face an issue using a connector or with the platform you're welcome to report opening a Github issue.
https://github.com/airbytehq/airbyte


## Airbyte Slack
You can access Airbyte Slack [here](https://slack.airbyte.com/).

**Before posting on a channel this please first check if a similar question was already answered.**

**The existing categories**:
* `#help-connections-issues`: for any questions or issues on your connections
* `#help-infrastructure-deployment`: for any questions or issues on your deployment and infrastructure
* `#help-connector-development`: for any questions about on the CDKs and issues while building a custom connector
* `#help-api-cli-orchestration`: for any questions or issues about the API, CLI, any scheduling effort.
* `#help-contributions`: for any questions about contributing to Airbyte’s codebase

## Airbyte Forum
We are driving our community support from our [forum](https://discuss.airbyte.io/).

**Before posting on this forum please first check if a similar question was already answered.**

**The existing categories**:
* [Connector Issues](https://discuss.airbyte.io/c/issues/11): Support requests on connector issues.
* [Platform, Deploy & Infra Issues](https://discuss.airbyte.io/c/deploy-infra-issues/24): Discussion about Airbyte Platform or deploys/infrastructure issues.
* [API, CLI & Orchestrations Issues](https://discuss.airbyte.io/c/api-cli-orchestration-issues/25): Discussion about how to use or issues with the API, CLI or orchestration
* [Connector Development](https://discuss.airbyte.io/c/connector-development/16): Ask help when you're developing a new connector.
* [Q&A](https://discuss.airbyte.io/c/faq/15): Ask anything that doesn’t belong to the other categories.
* [Guides](https://discuss.airbyte.io/c/guides/17): Small tutorials and guides solving deployments or workarounds using connectors.
* [Frequently Asked Questions](https://discuss.airbyte.io/c/read-answers-by-the-airbyte-team-to-commonly-asked-questions-from-our-community/22): Read answers from the Airbyte team for commonly asked questions from the community.
27 changes: 0 additions & 27 deletions docs/troubleshooting/README.md

This file was deleted.

46 changes: 0 additions & 46 deletions docs/troubleshooting/new-connection.md

This file was deleted.

0 comments on commit d0fa40c

Please sign in to comment.