jprdonnelly/airbyte
1
0
Fork 0
mirror of synced 2025-12-19 18:14:56 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: update plan names in docs content (#67573)

Browse Source 
## What
<!--
* Describe what the change is solving. Link all GitHub issues related to
this change.
-->

This pull request updates plan names across most of the Documentation so
they're consistent with our current plan names.

## How
<!--
* Describe how code changes achieve the solution.
-->

My original plan was to convert free text to MDX variables so we only
had to make future updates to names in one place. While broadly
successful, there were numerous edge cases that made rolling this out
almost impossible. There were too many ways and places you couldn't use
variables due to a variety of limitations in Docusaurus and Airbyte's
internal MarkDown processor. Explaining how to properly use them made me
realize how prohibitively insufficient this was. In the end, I opted to
return to using free text for plan names.

Scope is now broadly reduced. This PR:

- Converts remaining instances of old plan names to new plan names. In
most cases, I replaced old plan names with new plan names directly. In
some cases, sentences were rewritten to make a bit more sense or be more
maintainable in the future.

- Removes previously added preprocessor variables from Docusaurus
configuration.

- Update Vale styles or various artifacts of content based on linter
findings.

## Review guide
<!--
1. `x.py`
2. `y.py`
-->

Spot check updated pages to ensure plan names appear appropriately. It's
probably not necessary to check every single instance in detail.

For Platform docs, changes only apply to the Next/Cloud version. After
merging, I'll regenerate 2.0 docs based on this. 1.8 and before won't be
updated.

## User Impact
<!--
* What is the end result perceived by the user?
* If there are negative side effects, please list them. 
-->

People can see correct plan names in docs content.

## Can this PR be safely reverted and rolled back?
<!--
* If unsure, leave it blank.
-->
- [x] YES 💚
- [ ] NO ❌

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This commit is contained in:
Ian Alton
2025-10-17 17:34:29 -07:00
committed by GitHub
parent 6cce359903
commit 4f97ee2dab
38 changed files with 109 additions and 121 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/integrations/README.md
View File

@@ -18,7 +18,7 @@ Each connector has one of the following support levels. Review [Connector suppor
- **Airbyte**: maintained by Airbyte.
- **Enterprise**: special, premium connectors available to Enterprise and Teams customers **for an additional cost**. To learn more about enterprise connectors, [talk to Sales](https://airbyte.com/company/talk-to-sales).
- **Enterprise**: special, premium connectors available to Enterprise and Pro customers **for an additional cost**. To learn more about enterprise connectors, [talk to Sales](https://airbyte.com/company/talk-to-sales).
- **Marketplace**: maintained by the open source community.

4
docs/integrations/connector-support-levels.md
View File

@@ -13,7 +13,7 @@ The following table describes the support levels of Airbyte connectors.
| **Support: Cloud** | Supported\* | Supported\* | No Support | Supported\*\* |
| **Support: Powered by Airbyte** | Supported\* | Supported\* | No Support | Supported\*\* |
| **Support: Self-Managed Enterprise** | Supported\* | Supported\* | No Support | Supported\*\* |
| **Support: Self-Managed Community** | Slack only | N/A | No Support | Slack only |
| **Support: Core** | Slack only | N/A | No Support | Slack only |
| **Who can use them** | Everyone | Extra license required | Everyone | You |
\*For Airbyte Connectors, Official Support SLAs are only available to customers with Premium
@@ -34,7 +34,7 @@ maintenance/upgrades are owned by the customer.
## Enterprise connectors
**Enterprise** Connectors are premium connectors available exclusively for Self-Managed Enterprise and Cloud Teams customers at **an additional cost**. These connectors:
**Enterprise** Connectors are premium connectors available exclusively for Self-Managed Enterprise and Pro customers at **an additional cost**. These connectors:
- Are built and maintained by the Airbyte team.
- Provide enhanced capabilities and support for critical enterprise systems.

2
docs/integrations/destinations/dev-null.md
View File

@@ -45,7 +45,7 @@ This mode throws an exception after receiving a configurable number of messages.
<details>
<summary>Expand to review</summary>
The OSS and Cloud variants have the same version number starting from version `0.2.2`.
The self-managed and Cloud variants have the same version number starting from version `0.2.2`.
| Version | Date | Pull Request | Subject |
|:------------|:-----------|:---------------------------------------------------------|:---------------------------------------------------------------------------------------------|

4
docs/integrations/enterprise-connectors/source-workday.md
View File

@@ -27,7 +27,7 @@ Airbyte's [Workday](https://workday.com) enterprise source connector currently o
- Workday username and password - A user account that has the necessary permissions to access the reports you want to sync.
- Report IDs - Each report in Workday has a unique Report ID.
## Setup Guide
## Setup guide
1. Log into your Airbyte Cloud account.
2. Click Sources and then click **+ New source**.
@@ -44,7 +44,7 @@ The Workday source connector supports the following [sync modes](https://docs.ai
- Full Refresh
## Supported Streams
## Supported streams
The Workday connector supports dynamic streams based on report ids provided in the source set up.

47
docs/integrations/sources/workday.md
View File

@@ -6,9 +6,9 @@ This premium connector is available to Enterprise customers at an additional cos
Airbyte's [Workday](https://workday.com) enterprise source connector currently offers the following features:
* Incremental as well as Full Refresh [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes). Note that incremental syncs are only supported for specific streams.
* Reliable replication at any size with [checkpointing](https://docs.airbyte.com/understanding-airbyte/airbyte-protocol/#state--checkpointing).
* Support for both REST API and Workday Report-as-a-Service (RaaS) streams. Each provided Report ID can be used as a separate stream with an auto-detected schema. Note that a separate Source must be created to use RaaS streams in addition to REST API streams.
- Incremental as well as Full Refresh [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes). Note that incremental syncs are only supported for specific streams.
- Reliable replication at any size with [checkpointing](https://docs.airbyte.com/understanding-airbyte/airbyte-protocol/#state--checkpointing).
- Support for both REST API and Workday Report-as-a-Service (RaaS) streams. Each provided Report ID can be used as a separate stream with an auto-detected schema. Note that a separate Source must be created to use RaaS streams in addition to REST API streams.
## Features
@@ -22,15 +22,15 @@ Airbyte's [Workday](https://workday.com) enterprise source connector currently o
## Prerequisites
* Workday tenant - The Organization ID for your Workday environment. This can be found by logging into your Workday account and going to My Account > Organization ID
* Workday hostname - The endpoint for connecting into your Workday environment. This can be found by logging into your Workday instance and searching “Public Web Service” in the search bar and selecting the appropriate report. Use the ellipse (...) button to select **Web Service > View WSDL**
- Workday tenant - The Organization ID for your Workday environment. This can be found by logging into your Workday account and going to My Account > Organization ID
- Workday hostname - The endpoint for connecting into your Workday environment. This can be found by logging into your Workday instance and searching “Public Web Service” in the search bar and selecting the appropriate report. Use the ellipse (...) button to select **Web Service** > **View WSDL**
* For REST API streams:
* Access token - An OAuth 2.0 access token for API client integrations. More information and instructions can be found in the Workday community documentation for your environment about creating and registering a Workday API Client. If you are using Airbyte Teams, when registering the API Client for Airbyte you can use https://cloud.airbyte.com/auth_flow for the Redirection URI field . If you are using Self-Managed Enterprise, you can use the URL of your Airbyte deployment instead.
- For REST API streams:
- Access token - An OAuth 2.0 access token for API client integrations. More information and instructions can be found in the Workday community documentation for your environment about creating and registering a Workday API Client. If you are using Airbyte Pro, when registering the API Client for Airbyte you can use https://cloud.airbyte.com/auth_flow for the Redirection URI field . If you are using Self-Managed Enterprise, you can use the URL of your Airbyte deployment instead.
* For Report-as-a-Service (RaaS) streams:
* Workday username and password - A user account that has the necessary permissions to access the reports you want to sync.
* Report IDs - Each report in Workday has a unique Report ID.
- For Report-as-a-Service (RaaS) streams:
- Workday username and password - A user account that has the necessary permissions to access the reports you want to sync.
- Report IDs - Each report in Workday has a unique Report ID.
## Setup Guide
@@ -67,25 +67,24 @@ Airbyte's [Workday](https://workday.com) enterprise source connector currently o
The Workday source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts/#connection-sync-modes):
* Full Refresh
* Incremental for the following REST API streams:
* Worker Payslips
* Worker Time Off Entries
- Full Refresh
- Incremental for the following REST API streams:
- Worker Payslips
- Worker Time Off Entries
## Supported Streams
The Workday connector supports the following REST API streams:
* Jobs
* Job Families
* Job Profiles
* People
* Workers
* Workers Direct Reports
* Worker History
* Worker Payslips (Incremental)
* Worker Time Off Entries (Incremental)
- Jobs
- Job Families
- Job Profiles
- People
- Workers
- Workers Direct Reports
- Worker History
- Worker Payslips (Incremental)
- Worker Time Off Entries (Incremental)
## Changelog

2
docs/platform/access-management/rbac.md
View File

@@ -7,7 +7,7 @@ products: oss-enterprise, cloud-teams
Role Based Access Control allows a user with Administrative access to apply roles to users, granting different levels of permission within an organization or workspace.
:::info
**Self-Managed Enterprise** instances have an `Instance Admin` role in addition to the other roles outlined in this document. The first user who logs on to Airbyte in a Self-Managed Enterprise instance will be assigned this role. This user will have all permissions listed below for all workspaces and all organizations associated with their Enterprise account. To update this assignment, enterprise customers should contact [Airbyte support](https://support.airbyte.com/hc/en-us).
**Self-Managed Enterprise** instances have an `Instance Admin` role in addition to the other roles outlined in this document. Airbyte assigns this role to the first user who logs on to Airbyte in a Self-Managed Enterprise instance. This user has all permissions listed below for all workspaces and all organizations associated with their Enterprise account. To update this assignment, enterprise customers should contact [Airbyte support](https://support.airbyte.com/hc/en-us).
:::
## Organization roles

4
docs/platform/access-management/role-mapping.md
View File

@@ -4,11 +4,11 @@ products: oss-enterprise, cloud-teams
# RBAC Role Mapping
Role-Based Access Control (RBAC) role mapping allows automatic assignment of specific permissions to Airbyte users based on existing roles in your organization. It ensures users have appropriate Airbyte access without manual oversight. RBAC functionality is only available in Airbyte Teams and Self-Managed Enterprise.
Role-Based Access Control (RBAC) role mapping allows automatic assignment of specific permissions to Airbyte users based on existing roles in your organization. It ensures users have appropriate Airbyte access without manual oversight.
Enabling role mapping in Airbyte requires use of the Airbyte API. The Airbyte API exposes endpoints that allow you to retrieve and update user permissions. These endpoints can be used to build automation that manages user access to different workspaces. This functionality is currently limited to the Airbyte API, and is not available in the Terraform Provider.
To enable the Airbyte API in Airbyte Teams or Self-Managed Enterprise, follow these [prerequisites](../enterprise-setup/api-access-config.md).
To enable the Airbyte API in Airbyte Pro, Enterprise Flex, or Self-Managed Enterprise, follow these [prerequisites](../enterprise-setup/api-access-config.md).
## Relevant API Endpoints

8
docs/platform/access-management/sso-providers/azure-entra-id.md
View File

@@ -20,7 +20,7 @@ This guide is for administrators. It assumes you have:
The exact process differs between the Cloud or Self-Managed versions of Airbyte. Steps for both are below.
## Cloud Teams with Entra ID OIDC
## Cloud Pro with Entra ID OIDC
:::warning
For security purposes, Airbyte disables existing [applications](/platform/enterprise-setup/api-access-config) used to access the Airbyte API once the user who owns the application signs in with SSO for the first time. Replace any Application secrets that were previously in use to ensure your integrations don't break.
@@ -114,7 +114,7 @@ To prevent a situation where you could lock yourself out of Airbyte, we require
### Create application
You will need to create a new Entra ID application for Airbyte. Log into the [Azure Portal](https://portal.azure.com/) and search for the Entra ID service.
You need to create a new Entra ID application for Airbyte. Log into the [Azure Portal](https://portal.azure.com/) and search for the Entra ID service.
From the overview page of Entra ID, press **Add** > **App registration** on the top of the screen. The name you select is your app integration name. Once chosen, **choose who can use the application, typically set to "Accounts in this organization directory only" for specific access,** and configure a **Redirect URI** of type **Web** with the following value:
@@ -141,12 +141,12 @@ Depending on the default "Admin consent require' value for your organization you
Once your Microsoft Entra ID app is set up, you're ready to deploy Airbyte Self-Managed Enterprise with SSO. Take note of the following configuration values, as you will need them to configure Airbyte to use your new SSO app integration:
* OpenID Connect metadata document: You'll find this in the list of endpoints found in the **Endpoints** panel, which you can open from the top bar of the **Overview** page. This will be used to populate the `Domain` field in your `airbyte.yml`.
* OpenID Connect metadata document: You'll find this in the list of endpoints found in the **Endpoints** panel, which you can open from the top bar of the **Overview** page. This will be used to populate the `Domain` field in your `values.yaml`.
* App Integration Name: The name of the Entra ID application created in the first step.
* Client ID: You'll find this in the **Essentials** section on the **Overview** page of the application you created.
* Client Secret: The client secret you copied in the previous step.
Use this information to configure the auth details of your `airbyte.yml` for your Self-Managed Enterprise deployment. To learn more on deploying Self-Managed Enterprise, see our [implementation guide](/platform/enterprise-setup/implementation-guide).
Use this information to configure the auth details of your `values.yaml` for your Self-Managed Enterprise deployment. To learn more on deploying Self-Managed Enterprise, see the [implementation guide](/platform/enterprise-setup/implementation-guide).
## Self-Managed Enterprise with Entra ID Generic OIDC

2
docs/platform/access-management/sso-providers/okta.md
View File

@@ -20,7 +20,7 @@ This guide is for administrators. It assumes you have:
The exact process differs between the Cloud or Self-Managed versions of Airbyte. Steps for both are below.
## Cloud Teams with Okta OIDC
## Cloud Pro with Okta OIDC
Follow the steps below to set up single sign on with Okta.

4
docs/platform/api-documentation.md
View File

@@ -4,7 +4,7 @@ products: all
# API documentation
The Airbyte API provides a way for developers to programmatically interact with Airbyte. It is available for all Airbyte products: Airbyte OSS, Cloud & Self-Hosted Enterprise.
The Airbyte API provides a way for developers to programmatically interact with Airbyte. It is available for all Airbyte plans.
Our API is a reliable, easy-to-use interface for programmatically controlling the Airbyte platform. It can be extended to:
@@ -22,7 +22,7 @@ Navigate to our full API documentation to learn how to retrieve your access toke
Our full API documentation is located here: [reference.airbyte.com](https://reference.airbyte.com/reference/getting-started).
:::note
Only for OSS users, to access the API in the OSS edition, you need to use the `/api/public/v1` path prefix. (ex: retrieve list of workspaces with `curl http://localhost:8000/api/public/v1/workspaces`)
To access the API in the Core plan, use the `/api/public/v1` path prefix. For example, retrieve list of workspaces with `curl http://localhost:8000/api/public/v1/workspaces`.
:::
## Configuration API (Deprecated)

10
docs/platform/community/getting-support.md
View File

@@ -6,9 +6,9 @@ products: all
Hold up! Have you looked at [our docs](https://docs.airbyte.com/) yet? We recommend searching the wealth of knowledge in our documentation as many times the answer you are looking for is there!
## Airbyte Open Source Support
## Core support
Running Airbyte Open Source and have questions that our docs could not clear up? Post your questions on our [Github Discussions](https://github.com/airbytehq/airbyte/discussions?_gl=1*70s0c6*_ga*MTc1OTkyOTYzNi4xNjQxMjQyMjA0*_ga_HDBMVFQGBH*MTY4OTY5MDQyOC4zNDEuMC4xNjg5NjkwNDI4LjAuMC4w) and also join our community Slack to connect with other Airbyte users.
If you're running Airbyte Core and have a question the docs couldn't clear up, post your question as a [Github Discussions](https://github.com/airbytehq/airbyte/discussions?_gl=1*70s0c6*_ga*MTc1OTkyOTYzNi4xNjQxMjQyMjA0*_ga_HDBMVFQGBH*MTY4OTY5MDQyOC4zNDEuMC4xNjg5NjkwNDI4LjAuMC4w) and also join our community Slack to connect with other Airbyte users.
### Community Slack
@@ -22,7 +22,7 @@ If you require personalized support, reach out to our sales team to inquire abou
We are driving our community support from our [forum](https://github.com/airbytehq/airbyte/discussions) on GitHub.
## Airbyte Cloud Support
## Cloud support (Standard, Pro, Enterprise Flex)
If you have questions about connector setup, error resolution, or want to report a bug, Airbyte Support is available to assist you. We recommend checking [our documentation](https://docs.airbyte.com/) and searching our [Help Center](https://support.airbyte.com/hc/en-us) before opening a support ticket.
@@ -38,9 +38,9 @@ To stay updated on Airbyte's future plans, take a look at [our roadmap](https://
Please be sure to sign up for Airbyte with your company email address, as we do not support personal accounts.
## Airbyte Enterprise (self-hosted) Support
## Self-Managed Enterprise support
If you're running Airbyte Open Source with Airbyte Enterprise or have an OSS support package, we're here to help you with upgrading Airbyte versions, debugging connector issues, or troubleshooting schema changes.
If you're running Self-Managed Enterprise, Airbyte's support team here to help you with upgrading Airbyte versions, debugging connector issues, or troubleshooting schema changes.
Before opening a support ticket, we recommend consulting [our documentation](https://docs.airbyte.com/) and searching our [Help Center](https://support.airbyte.com/hc/en-us). If your question remains unanswered, please submit a ticket through our Help Center. We suggest creating an [Airbyte Help Center account](https://airbyte1416.zendesk.com/auth/v2/login/signin?return_to=https%3A%2F%2Fsupport.airbyte.com%2Fhc%2Fen-us&theme=hc&locale=en-us&brand_id=15365055240347&auth_origin=15365055240347%2Ctrue%2Ctrue) to access your organization's support requests. Our team is online and availible to assist from 7AM - 7PM Eastern.

2
docs/platform/connector-development/README.md
View File

@@ -16,7 +16,7 @@ If you need support along the way, visit the [Slack channel](https://airbytehq.s
1. **Pick the technology and build**. The first step in creating a new connector is to choose the tools you’ll use to build it. For _most_ cases, you should start in Connector Builder.
2. **Publish as a custom connector**. After building and testing your connector, you’ll need to publish it. This makes it available in your workspace. At that point, you can use the connector you’ve built to move some data!
3. **Contribute back to Airbyte**. If you want to contribute what you've built to the Airbyte Cloud and OSS connector catalog, follow the steps provided in the [contribution guide for submitting new connectors](./submit-new-connector.md).
3. **Contribute back to Airbyte**. If you want to contribute what you’ve built to the connector Marketplace, follow the steps provided in the [contribution guide for submitting new connectors](../connector-development/submit-new-connector.md).
## Connector development options

2
docs/platform/connector-development/connector-builder-ui/custom-components.md
View File

@@ -51,7 +51,7 @@ When enabled, Custom Components bring the full flexibility of the Low-Code CDK i
Custom Components are currently considered **UNSAFE** and **EXPERIMENTAL**. Airbyte doesn't provide any sandboxing guarantees. This feature could execute arbitrary code in your Airbyte environment. Enable it at your own risk.
:::
Airbyte disables Custom Components by default due to their experimental nature and security implications. Administrators can enable this feature in Self-Managed Community and Self-Managed Enterprise deployments using one of the following methods:
Airbyte disables Custom Components by default due to their experimental nature and security implications. Administrators can enable this feature in Core and Self-Managed Enterprise deployments using one of the following methods:
### Using abctl

2
docs/platform/deploying-airbyte/chart-v2-community.mdx
View File

@@ -7,7 +7,7 @@ import TabItem from '@theme/TabItem';
import EnvironmentVarConversion from '@site/static/_extraenv_to_helm_chart_v2.md';
import HelmSyntaxConversion from '@site/static/_helm-chart-2-syntax-changes.md';
# Upgrade to Helm chart V2 (Self-Managed Community)
# Upgrade to Helm chart V2 (Core)
Airbyte has upgraded its Helm chart to a new version called "V2." Using Helm chart V2 is currently optional. At some future date the V2 Helm chart will become the standard, so we advise that you upgrade your existing deployment to use the new chart before the transition. If you're a new Airbyte user, you can skip the upgrade altogether and start with the new chart.

2
docs/platform/deploying-airbyte/deploying-airbyte.md
View File

@@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem';
The Airbyte platform is a sophisticated data integration platform that enables you to handle large amounts of data movement.
To quickly deploy Airbyte on your local machine you can visit the [Quickstart](../using-airbyte/getting-started/oss-quickstart) guide.
If setting up an Airbyte server does not fit your use case needs (i.e. you're using Jupyter Notebooks or iterating on an early prototype for your project) you may find the [PyAirbyte](../using-airbyte/pyairbyte/getting-started) documentation useful.
If setting up an Airbyte server does not fit your use case needs (for example, you're using Jupyter Notebooks or iterating on an early prototype for your project) you may find the [PyAirbyte](../using-airbyte/pyairbyte/getting-started) documentation useful.
:::info Self-Managed Enterprise customers
If you're a Self-Managed Enterprise customer, skip this guide. Instead, follow the steps outlined in [Self-Managed Enterprise](../enterprise-setup/README.md) and the associated [implementation guide](../enterprise-setup/implementation-guide.md).

2
docs/platform/deploying-airbyte/integrations/ingress-1-7.md
View File

@@ -7,7 +7,7 @@ import TabItem from '@theme/TabItem';
# Update ingress for version 1.7 and later
Airbyte version 1.7 introduced a breaking change for ingress to the Connector Builder. If you're a Self-Managed Community user or Self-Managed Enterprise customer, and you're upgrading to version 1.7.0 or later, complete these steps when you upgrade. If you don't, the Connector Builder gives you 403 Forbidden errors and you can't test streams or use the Connector Builder UI.
Airbyte version 1.7 introduced a breaking change for ingress to the Connector Builder. If you're a Core user or Self-Managed Enterprise customer, and you're upgrading to version 1.7.0 or later, complete these steps when you upgrade. If you don't, the Connector Builder gives you 403 Forbidden errors and you can't test streams or use the Connector Builder UI.
## What changed

11
docs/platform/enterprise-flex/readme.md
View File

@@ -21,7 +21,7 @@ Many organizations collect data in all types of operational systems from users a
While these requirements are critical, organizations also have finite time and expertise. Managing these operational and compliance requirements with more infrastructure often means increased maintenance commitments, higher spend, and greater complexity.
Enterprise Flex addresses these needs by offering fully managed Cloud workspaces (a control plane) that connect to separate data planes you manage in your own infrastructure. You can also use fully managed data planes for less sensitive data that doesn't need to remain in your own infrastructure. Each Cloud workspace uses one region and data plane, so a single Airbyte instance with multiple workspaces is an ideal way to segregate data and connections. Enterprise Flex also supports other enterprise-grade abilities such as audit loggings, external secrets managers, and AWS PrivateLink connectivity in addition to all other features in Cloud Teams.
Enterprise Flex addresses these needs by offering fully managed Cloud workspaces (a control plane) that connect to separate data planes you manage in your own infrastructure. You can also use fully managed data planes for less sensitive data that doesn't need to remain in your own infrastructure. Each Cloud workspace uses one region and data plane, so a single Airbyte instance with multiple workspaces is an ideal way to segregate data and connections. Enterprise Flex also supports other enterprise-grade abilities such as audit logging, external secrets managers, and AWS PrivateLink connectivity in addition to all other features in Cloud Pro.
| Feature | Description |
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -35,16 +35,15 @@ Enterprise Flex addresses these needs by offering fully managed Cloud workspaces
| AWS PrivateLink | Connect to data sources or destinations in your VPC securely to Airbyte data planes. |
| Support with SLAs | [Priority assistance](https://docs.airbyte.com/operator-guides/contact-support/#airbyte-enterprise-self-hosted-support) with deploying, managing and upgrading Airbyte. |
### Enterprise Flex versus Cloud Teams
### Enterprise Flex versus Pro
Enterprise Flex includes all features that are standard in Cloud Teams with the additional capabilities of running self-managed data planes, referencing your own secrets manager, and storing audit logs.
Any Airbyte Cloud enviornment can be easily upgraded to Enterprise Flex. To learn more about upgrading to Enterprise Flex, [talk to sales](https://airbyte.com/company/talk-to-sales).
Enterprise Flex includes all features that are standard in Pro with the additional capabilities of running self-managed data planes, referencing your own secrets manager, PrivateLink support, and storing audit logs.
Any Airbyte Cloud environment can be easily upgraded to Enterprise Flex. To learn more about upgrading to Enterprise Flex, [talk to sales](https://airbyte.com/company/talk-to-sales).
## An example hybrid deployment
Every organization's precise needs differ, so you can implement Enterprise Flex in the way that suits you best. In this example, you have three workspaces.
Every organization's precise needs differ, so you can implement Enterprise Flex in the way that suits you best. In this example, you have three workspaces.
- Workspace 1 contains non-sensitive data and uses Airbyte's fully managed European region.

4
docs/platform/enterprise-setup/README.md
View File

@@ -4,8 +4,7 @@ products: oss-enterprise
# Airbyte Self-Managed Enterprise
[Airbyte Self-Managed Enterprise](https://airbyte.com/product/airbyte-enterprise) is the best way to run Airbyte yourself. You get all 600+ pre-built connectors, data never leaves your environment, and Self-Managed Enterprise introduces several new governance capabilities targeted towards large organizations designed to enhance your data platform’s capabilities and security.
[Airbyte Self-Managed Enterprise](https://airbyte.com/product/airbyte-enterprise) is the best way to run Airbyte yourself. You get all 600+ pre-built connectors, data never leaves your environment, and Self-Managed Enterprise introduces new governance capabilities targeted towards large organizations designed to enhance your data platform’s capabilities and security.
| Feature | Description |
|---------------------|------------------------------------------------------------------------------------------------------------------------|
@@ -21,5 +20,4 @@ A valid license key is required to get started with Airbyte Self-Managed Enterpr
1. [Deploy Airbyte Enterprise using Kubernetes](./implementation-guide.md)
2. [Configure Okta for Single Sign-On (SSO) with Airbyte Self-Managed Self-Managed Enterprise](/platform/access-management/sso)
![AWS Architecture Diagram](./assets/self-managed-enterprise-aws.png)

2
docs/platform/enterprise-setup/chart-v2-enterprise.mdx
View File

@@ -12,7 +12,7 @@ import HelmSyntaxConversion from '@site/static/_helm-chart-2-syntax-changes.md';
Airbyte has upgraded its Helm chart to a new version called "V2." Upgrading to Helm chart V2 is currently optional. At some future date the V2 Helm chart will become the standard, so we advise that you upgrade your existing deployment to use the new chart before the transition. If you're a new Airbyte customer, you can skip the upgrade altogether and start with the new chart.
:::important Open Source Users
Follow the [Self-Managed Community guide](../deploying-airbyte/chart-v2-community) instead.
Follow the [Core guide](../deploying-airbyte/chart-v2-community) instead.
:::
## Why you should upgrade

16
docs/platform/enterprise-setup/implementation-guide.md
View File

@@ -20,11 +20,11 @@ Airbyte has begun rolling out a new Helm chart called Helm chart V2. The instruc
### Infrastructure Prerequisites
For a production-ready deployment of Self-Managed Enterprise, various infrastructure components are required. We recommend deploying to Amazon EKS or Google Kubernetes Engine. The following diagram illustrates a typical Airbyte deployment running on AWS:
For a production-ready deployment of Self-Managed Enterprise, the following infrastructure components are required. Deploy to Amazon EKS or Google Kubernetes Engine. The following diagram illustrates a typical Airbyte deployment running on AWS:
![AWS Architecture Diagram](./assets/self-managed-enterprise-aws.png)
Prior to deploying Self-Managed Enterprise, we recommend having each of the following infrastructure components ready to go. When possible, it's easiest to have all components running in the same [VPC](https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html). The provided recommendations are for customers deploying to AWS:
Prior to deploying Self-Managed Enterprise, Airbyte recommends having each of the following infrastructure components ready to go. When possible, it's easiest to have all components running in the same [VPC](https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html). The provided recommendations are for customers deploying to AWS:
| Component | Recommendation |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -36,10 +36,10 @@ Prior to deploying Self-Managed Enterprise, we recommend having each of the foll
A few notes on Kubernetes cluster provisioning for Airbyte Self-Managed Enterprise:
- We support Amazon Elastic Kubernetes Service (EKS) on EC2, Google Kubernetes Engine (GKE) on Google Compute Engine (GCE), and Azure Kubernetes Service (AKS).
- We recommend running Airbyte on memory-optimized instances, such as M7i / M7g instance types.
- While we support GKE Autopilot, we do not support Amazon EKS on Fargate.
- We recommend running Airbyte on instances with at least 2 cores and 8 gigabytes of RAM.
- Airbyte supports Amazon Elastic Kubernetes Service (EKS) on EC2, Google Kubernetes Engine (GKE) on Google Compute Engine (GCE), and Azure Kubernetes Service (AKS).
- Airbyte recommends running Airbyte on memory-optimized instances, such as M7i / M7g instance types.
- While Airbyte supports GKE Autopilot, it doesn't support Amazon EKS on Fargate.
- You should run Airbyte on instances with at least 2 cores and 8 gigabytes of RAM.
We require you to install and configure the following Kubernetes tooling:
@@ -394,7 +394,7 @@ The following subsections help you customize your deployment to use an external
#### Configuring the Airbyte Database
For Self-Managed Enterprise deployments, we recommend using a dedicated database instance for better reliability, and backups (such as AWS RDS or GCP Cloud SQL) instead of the default internal Postgres database (`airbyte/db`) that Airbyte spins up within the Kubernetes cluster.
For Self-Managed Enterprise deployments, you must use a dedicated database instance for better reliability and backups, such as AWS RDS or GCP Cloud SQL. Don't use the default internal Postgres database, `airbyte/db`, that Airbyte spins up within the Kubernetes cluster.
We assume in the following that you've already configured a Postgres instance:
@@ -476,7 +476,7 @@ global:
#### Configuring External Logging
For Self-Managed Enterprise deployments, we recommend spinning up standalone log storage for additional reliability using tools such as S3 and GCS instead of against using the default internal Minio storage (`airbyte/minio`). It's then a common practice to configure additional log forwarding from external log storage into your observability tool.
For Self-Managed Enterprise deployments, spin up standalone log storage for additional reliability using tools such as S3 and GCS. Don't use the default internal MinIO storage, `airbyte/minio`. It's then a common practice to configure additional log forwarding from external log storage into your observability tool.
<details>
<summary>External log storage setup steps</summary>

6
docs/platform/enterprise-setup/scaling-airbyte.md
View File

@@ -7,7 +7,7 @@ import TabItem from '@theme/TabItem';
# Scaling Airbyte After Installation
Once you've completed the initial installation of Airbyte Self-Managed Enterprise, the next crucial step is scaling your setup as needed to ensure optimal performance and reliability as your data integration needs grow. This guide will walk you through best practices and strategies for scaling Airbyte in an enterprise environment.
Once you've completed the initial installation of Airbyte Self-Managed Enterprise, the next crucial step is scaling your setup as needed to ensure optimal performance and reliability as your data integration needs grow. This guide walks you through best practices and strategies for scaling Airbyte in an enterprise environment.
## Concurrent Syncs
@@ -243,9 +243,9 @@ Furthermore, you may want to implement a primary-replica setup for the database
For business-critical applications of Airbyte, you may want to configure a Disaster Recovery (DR) cluster for Airbyte. We do not support assisting customers with DR deployments at this time. However, we offer a few high level suggestions:
1. We strongly recommend configuring an external database, external log storage and external connector secret management.
1. Airbyte strongly recommends configuring an external database, external log storage and external connector secret management.
2. We strongly recommend that your DR cluster is also an instance of Self-Managed Enterprise, kept at the same version as your prod instance.
2. Airbyte strongly recommends that your DR cluster is also an instance of Self-Managed Enterprise, kept at the same version as your prod instance.
## DEBUG Logs

2
docs/platform/enterprise-setup/upgrade-service-account.md
View File

@@ -4,7 +4,7 @@ products: oss-enterprise
# Update service account for 1.6
Airbyte version 1.6 introduced a breaking change for service account permissions. If you're a Self-Managed Enterprise customer upgrading from 1.5.1 or earlier to 1.6 or later, follow the directions in this article before you upgrade to 1.6. If you're a Self-Managed Community user, this information isn't relevant to you. [Learn more about service accounts](https://kubernetes.io/docs/concepts/security/service-accounts/).
Airbyte version 1.6 introduced a breaking change for service account permissions. If you're a Self-Managed Enterprise customer upgrading from 1.5.1 or earlier to 1.6 or later, follow the directions in this article before you upgrade to 1.6. If you're a Core user, this information isn't relevant to you. [Learn more about service accounts](https://kubernetes.io/docs/concepts/security/service-accounts/).
## Upgrading without updating service account permissions

4
docs/platform/enterprise-setup/upgrading-from-community.md
View File

@@ -7,7 +7,7 @@ import TabItem from '@theme/TabItem';
# Existing Instance Upgrades
This page supplements the [Self-Managed Enterprise implementation guide](./implementation-guide.md). It highlights the steps to take if you are currently using Airbyte Self-Managed Community, our free open source offering, and are ready to upgrade to [Airbyte Self-Managed Enterprise](./README.md).
This page supplements the [Self-Managed Enterprise implementation guide](./implementation-guide.md). It highlights the steps to take if you are currently using Airbyte Core, our free open source offering, and are ready to upgrade to [Airbyte Self-Managed Enterprise](./README.md).
A valid license key is required to get started with Airbyte Enterprise. [Talk to sales](https://airbyte.com/company/talk-to-sales) to receive your license key.
@@ -62,7 +62,7 @@ Update your `values.yaml` file as explained in the [Self-Managed Enterprise impl
</TabItem>
</Tabs>
2. Once this is complete, you will need to upgrade your ingress to include the new `/auth` path. The following is a skimmed down definition of an ingress resource you could use for Self-Managed Enterprise:
2. Once this is complete, you need to upgrade your ingress to include the new `/auth` path. The following is a skimmed down definition of an ingress resource you could use for Self-Managed Enterprise:
<details>
<summary>Configuring your Airbyte ingress</summary>

4
docs/platform/managing-airbyte/connector-updates.md
View File

@@ -30,13 +30,13 @@ Each connector's changelog details its update history. You can find it in the [c
## How Airbyte Handles Connector Updates
### Airbyte Cloud
### Cloud plans
**Minor and Patch Versions:** These are applied automatically and immediately to your instance. You don't need to take any action.
**Major Versions:** A major version will include notable changes that affect your schema or sync success. We will notify you ahead of time to give you a window to prepare for the change. At the end of the window, we will automatically upgrade your connector to ensure you receive the latest updates. Examples of major version changes are shared in our [breaking change documentation](/platform/using-airbyte/schema-change-management#major-connector-version-upgrades).
### Airbyte Open Source (OSS) and Self-Managed Enterprise (SME)
### Self-managed plans
Airbyte recommends using the latest version of Airbyte when updating connections.

2
docs/platform/operator-guides/configuring-connector-resources.md
View File

@@ -66,7 +66,7 @@ You can use SQL to configure connector definitions, affecting all connectors of
## Configuring Connector-Specific Requirements
Self-Managed Enterprise customers can configure resource allocation through the "Connector resource allocation" dropdown in the Settings tab for each connector. You can also configure this with the API. This option isn't available for Self-Managed Community users.
Self-Managed Enterprise customers can configure resource allocation through the "Connector resource allocation" dropdown in the Settings tab for each connector. You can also configure this with the API. This option isn't available for Core users.
The available profiles depend on the connector type. Specific resource requirements and options vary by connector. As a general rule, resource allocations look something like this.

10
docs/platform/operator-guides/telemetry.md
View File

@@ -60,15 +60,11 @@ If you'd like to turn off telemetry data collection, follow the directions below
Anonymous usage tracking ("telemetry") helps us understand how PyAirbyte is being used,
including which connectors are working well and which connectors are frequently failing. This helps
us to prioritize product improvements which benefit users of PyAirbyte as well as Airbyte Cloud,
OSS, and Enterprise.
us to prioritize product improvements.
We will _never_ collect any information which could be considered PII (personally identifiable
information) or sensitive data. We _do not_ collect IP addresses, hostnames, or any other
information that could be used to identify you or your organization.
Airbyte _never_ collects any personally identifiable information (PII) or sensitive data. This includes IP addresses, host names, or any other information that could be used to identify you or your organization.
You can opt-out of anonymous usage reporting by setting the environment variable `DO_NOT_TRACK`
to any value.
You can opt-out of anonymous usage reporting by setting the environment variable `DO_NOT_TRACK` to any value.
</TabItem>
</Tabs>

2
docs/platform/operator-guides/upgrading-airbyte.md
View File

@@ -59,7 +59,7 @@ Upgrade by updating your `values.yaml` file and redeploying Airbyte. If you're n
## Upgrading Airbyte deployed with abctl
`abctl` streamlines the way you manage a local installation of Airbyte OSS.
`abctl` streamlines the way you manage a local installation of Airbyte Core.
Run `abctl local install` to upgrade to the latest version of Airbyte. If you'd like to ensure you're running the latest version of Airbyte, you can check the value of the Helm Chart's app version by running `abctl local status`.

9
docs/platform/operator-guides/using-the-airflow-airbyte-operator.md
View File

@@ -3,17 +3,14 @@ description: Start triggering Airbyte jobs with Apache Airflow in minutes
products: oss-*
---
# Using the Airbyte Operator to orchestrate Airbyte OSS
# Using the Airbyte Operator to orchestrate Airbyte Core
Airbyte is an official community provider for the Apache Airflow project. The Airbyte operator allows you to trigger Airbyte OSS synchronization jobs from Apache Airflow, and this article will walk through configuring your Airflow DAG to do so.
Airbyte is an official community provider for the Apache Airflow project. The Airbyte operator allows you to trigger Airbyte self-managed synchronization jobs from Apache Airflow, and this article walks you through configuring your Airflow DAG to do so.
:::note
For [historic reasons](https://github.com/airbytehq/airbyte/issues/836), the Airbyte operator is designed to work with the internal [Config API](https://airbyte-public-api-docs.s3.us-east-2.amazonaws.com/rapidoc-api-docs.html) rather than the newer [Airbyte API](https://reference.airbyte.com/reference/start) and is therefore not intended or designed for orchstrating Airbyte Cloud. As an alternative, it is possible to make use of [Airflow's HTTP operators](https://airflow.apache.org/docs/apache-airflow-providers-http/stable/operators.html) with both Airbyte OSS and Airbyte Cloud. This approach is described in [Using the new Airbyte API to orchestrate Airbyte Cloud with Airflow](https://airbyte.com/blog/orchestrating-airbyte-api-airbyte-cloud-airflow).
For [historic reasons](https://github.com/airbytehq/airbyte/issues/836), the Airbyte operator is designed to work with the internal [Config API](https://airbyte-public-api-docs.s3.us-east-2.amazonaws.com/rapidoc-api-docs.html) rather than the newer [Airbyte API](https://reference.airbyte.com/reference/start) and is therefore not intended or designed for orchestrating Airbyte Cloud. As an alternative, it is possible to make use of [Airflow's HTTP operators](https://airflow.apache.org/docs/apache-airflow-providers-http/stable/operators.html) with both Airbyte self-managed and Cloud. This approach is described in [Using the new Airbyte API to orchestrate Airbyte Cloud with Airflow](https://airbyte.com/blog/orchestrating-airbyte-api-airbyte-cloud-airflow).
:::
The Airbyte Provider documentation on Airflow project can be found [here](https://airflow.apache.org/docs/apache-airflow-providers-airbyte/stable/index.html).
## 1. Set up the tools

2
docs/platform/organizations-workspaces/readme.md
View File

@@ -8,6 +8,6 @@ import DocCardList from '@theme/DocCardList';
Organizations and workspaces are the highest levels of structure in Airbyte. They're the primary ways you segregate data and connections, manage access, and control billing.
If you use Self-Managed Community, you only have one organization and one workspace, so these concepts aren't relevant to you. If you use Cloud Standard, each organization is limited to one workspace. You can upgrade to Pro or Enterprise Flex to access multiple workspaces per organization.
If you use Core, you only have one organization and one workspace, so these concepts aren't relevant to you. If you use Cloud Standard, each organization is limited to one workspace. You can upgrade to Pro or Enterprise Flex to access multiple workspaces per organization.
<DocCardList />

2
docs/platform/organizations-workspaces/workspaces/readme.md
View File

@@ -24,6 +24,6 @@ You can use workspaces for the following purposes.
- Set up notifications.
If you use Self-Managed Community, you only have one workspace. If you use Cloud Standard, each organization is limited to one workspace. You can upgrade to Pro or Enterprise Flex to access multiple workspaces per organization.
If you use Core, you only have one workspace. If you use Cloud Standard, each organization is limited to one workspace. You can upgrade to Pro or Enterprise Flex to access multiple workspaces per organization.
<DocCardList />

10
docs/platform/readme.md
View File

@@ -19,9 +19,9 @@ Airbyte is available as a self-managed, hybrid, or fully managed cloud solution.
<Grid columns="2">
<CardWithIcon title="{{product_name_sm_enterprise}}" description="Highly available, secure data movement for your entire organization. Keep your data sovereign and on your premises with self-managed data planes" ctaText="Enterprise setup" ctaLink="/platform/enterprise-setup" icon="fa-lock" />
<CardWithIcon title="Self-Managed Enterprise" description="Highly available, secure data movement for your entire organization. Keep your data sovereign and on your premises with self-managed data planes" ctaText="Enterprise setup" ctaLink="/platform/enterprise-setup" icon="fa-lock" />
<CardWithIcon title="{{product_name_sm_oss}}" description="Our free and open-source version of Airbyte. Deploy locally or in your own infrastructure. Get started immediately and keep your data on your premises." ctaText="Quickstart" ctaLink="using-airbyte/getting-started/oss-quickstart" icon="fa-download" />
<CardWithIcon title="Core" description="Our free and open-source version of Airbyte. Deploy locally or in your own infrastructure. Get started immediately and keep your data on your premises." ctaText="Quickstart" ctaLink="using-airbyte/getting-started/oss-quickstart" icon="fa-download" />
</Grid>
@@ -29,11 +29,11 @@ Airbyte is available as a self-managed, hybrid, or fully managed cloud solution.
<Grid columns="3">
<CardWithIcon title="{{product_name_cloud_standard}}" description="A cloud solution that provides a fully managed experience for data replication. Focus on moving data while Airbyte manages the infrastructure. Free 30-day trial." ctaText="Sign up" ctaLink="https://cloud.airbyte.com/signup" icon="fa-cloud" />
<CardWithIcon title="Standard" description="A cloud solution that provides a fully managed experience for data replication. Focus on moving data while Airbyte manages the infrastructure. Free 30-day trial." ctaText="Sign up" ctaLink="https://cloud.airbyte.com/signup" icon="fa-cloud" />
<CardWithIcon title="{{product_name_cloud_pro}}" description="A cloud solution for organizations looking to scale efficiently. Role based access control, single sign on, and more ensure Pro is a robust solution that can grow with your team." ctaText="Talk to Sales" ctaLink="https://airbyte.com/company/talk-to-sales" icon="fa-lock" />
<CardWithIcon title="Pro" description="A cloud solution for organizations looking to scale efficiently. Role based access control, single sign on, and more ensure Pro is a robust solution that can grow with your team." ctaText="Talk to Sales" ctaLink="https://airbyte.com/company/talk-to-sales" icon="fa-lock" />
<CardWithIcon title="{{product_name_cloud_enterprise}}" description="An enterprise-grade, hybrid solution with for organizatons seeking the convenience of a fully managed solution with separate data planes for compliance and data sovereignty." ctaText="Learn more" ctaLink="enterprise-flex" icon="fa-lock" />
<CardWithIcon title="Enterprise Flex" description="An enterprise-grade, hybrid solution with for organizatons seeking the convenience of a fully managed solution with separate data planes for compliance and data sovereignty." ctaText="Learn more" ctaLink="enterprise-flex" icon="fa-lock" />
</Grid>

4
docs/platform/terraform-documentation.md
View File

@@ -7,7 +7,7 @@ import TabItem from '@theme/TabItem';
# Terraform provider
Follow this tutorial to learn how to use Airbyte's Terraform Provider.
Follow this tutorial to learn how to use Airbyte's Terraform Provider.
[Terraform](https://www.terraform.io/), developed by HashiCorp, is an Infrastructure as Code (IaC) tool that empowers you to define and provision infrastructure using a declarative configuration language. If you use Terraform to manage your infrastructure, you can use Airbyte's Terraform provider to automate and version control your Airbyte configuration as code. Airbyte's Terraform provider is built off [Airbyte's API](https://reference.airbyte.com).
@@ -15,7 +15,7 @@ If you don't need a tutorial, go straight to the [Terraform docs](https://regist
## Limitations and considerations
The Airbyte Terraform provider supports connectors that are available in **both** Self-Managed Community and Cloud. It doesn't support connectors that are only available in Self-Managed Community.
The Airbyte Terraform provider supports connectors that are available in **both** self-managed and cloud plans. It doesn't support connectors that are only available in self-managed plans.
## Requirements before you begin

2
docs/platform/using-airbyte/delivery-methods.md
View File

@@ -35,7 +35,7 @@ To ensure your source and destination credentials remain isolated, Airbyte uses
- Cloud: All Workspaces
- Self-Managed Community and Self-Managed Enterprise:
- Core and Self-Managed Enterprise:
- Version 1.2.0 or later to copy files.

2
docs/platform/using-airbyte/getting-started/oss-quickstart.md
View File

@@ -9,7 +9,7 @@ import { faWindows } from "@fortawesome/free-brands-svg-icons";
# Quickstart
This quickstart guides you through deploying a local instance of Airbyte Self-Managed Community, Airbyte's open source product. Setup only takes a few minutes, and you can start moving data immediately.
This quickstart guides you through deploying a local instance of Airbyte Core, Airbyte's open source product. Setup only takes a few minutes, and you can start moving data immediately.
## Overview

2
docs/release_notes/breaking-changes.md
View File

@@ -8,7 +8,7 @@ Occasionally, new versions of Airbyte introduce breaking changes. This page inve
When you upgrade your Self-Managed instance of Airbyte to a version with a breaking change, you may need to take mitigating action. If you are upgrading multiple versions at once, complete the mitigaton steps for the versions you are skipping as well.
## Self-Managed Community
## Core
### 1.8.x to 2.0.x

20
docs/vale-styles/config/vocabularies/Airbyte/accept.txt
View File

@@ -2,13 +2,8 @@
# Company vocabulary
#
Airbyte
Airbyte's
Self-Managed Community
Self-Managed Enterprise
Cloud
Cloud Teams
Enterprise Flex
Airbyte('s)?
[Cc]loud
abctl
Airbox
PyAirbyte
@@ -19,6 +14,13 @@ Low-Code CDK
Connection Timeline
Embedded
Airbyte Embedded
Sonar
Core
Standard
Plus
Pro
Enterprise Flex
Self-Managed Enterprise
#
# Common terms Airbyte uses
@@ -81,6 +83,8 @@ Zendesk
Okta
Entra
Slack
Fargate
MinIO
# Acceptable non-words that shouldn't trigger spellcheck
@@ -88,6 +92,7 @@ Slack
[Nn]amespaces
[Ii]nitialisms
\bCPU(?:s)?\b
hostname
# API and technical terms
@@ -124,6 +129,7 @@ datetime
workspace's
# Never lint Docusaurus admonitions markup
:::
:::note
:::tip

8
docusaurus/docusaurus.config.js
View File

@@ -22,14 +22,6 @@ const config = {
},
markdown: {
mermaid: true,
preprocessor: ({filePath, fileContent}) => {
return fileContent
.replace(/\{\{product_name_sm_oss\}\}/g, 'Core')
.replace(/\{\{product_name_sm_enterprise\}\}/g, 'Self-Managed Enterprise')
.replace(/\{\{product_name_cloud_standard\}\}/g, 'Standard')
.replace(/\{\{product_name_cloud_pro\}\}/g, 'Pro')
.replace(/\{\{product_name_cloud_enterprise\}\}/g, 'Enterprise Flex');
},
},
themes: [
"@docusaurus/theme-mermaid",

7
docusaurus/vale.ini
View File

@@ -6,7 +6,7 @@ StylesPath = ../docs/vale-styles
#Custom vocabulary definition
Vocab = Airbyte
# Minimum level at which Vale will trigger an alert.
# Minimum level at which Vale will trigger an alert
MinAlertLevel = suggestion
# External packages
@@ -18,7 +18,7 @@ Packages = Google, write-good, MDX
# What Vale lints with
BasedOnStyles = Vale, Google, write-good, airbyte
## Ignore some imported style rules because they're too esoteric or overlap with another library.
## Ignore some imported style rules because they're too esoteric or overlap with another library
write-good.E-Prime = NO
write-good.Passive = NO
write-good.TooWordy = NO
@@ -26,6 +26,7 @@ Vale.Terms = NO
## Ignore:
## - Anything in angle brackets that starts with an uppercase letter (IE a React component)
## - Anything in double curly braces (IE a MarkDown variable)
## - Single backticks
## - MarkDown links or images
## - URLS
@@ -33,7 +34,7 @@ Vale.Terms = NO
## - URLs without http
## - React component imports
## More info: https://vale.sh/docs/keys/tokenignores
TokenIgnores = (<\/?[A-Z].+>), (\x60[^\n\x60]+\x60), (\[[^\n]+[^\n]*\]\([^\n]+\)), (http[^\n]+), ([^\n]+@[^\n]+\.[^\n]+), (\[[^\n]+?\.(?:com|net|org|gov|ca|co|us|io|info|xyz|ai)\]), (import [^\n]+ from [^\n]+)
TokenIgnores = (<\/?[A-Z].+>), \{\{([^}]*)\}\}, (\x60[^\n\x60]+\x60), (\[[^\n]+[^\n]*\]\([^\n]+\)), (http[^\n]+), ([^\n]+@[^\n]+\.[^\n]+), (\[[^\n]+?\.(?:com|net|org|gov|ca|co|us|io|info|xyz|ai)\]), (import [^\n]+ from [^\n]+)
## Exclude certain block-level sections of text that don’t have an associated HTML tag that could be used with SkippedScopes.
## More info: https://vale.sh/docs/keys/blockignores