📚 Add availability information to docs (#33650)

airbytehq · Dec 20, 2023 · faedd86 · faedd86
1 parent 4718654
commit faedd86
Show file tree

Hide file tree

Showing 60 changed files with 357 additions and 25 deletions.
diff --git a/docs/access-management/sso-providers/okta.md b/docs/access-management/sso-providers/okta.md
@@ -1,5 +1,6 @@
 ---
 sidebar_label: Okta
+products: oss-enterprise, cloud-teams
 ---
 
 import Tabs from "@theme/Tabs";

diff --git a/docs/access-management/sso.md b/docs/access-management/sso.md
@@ -1,3 +1,7 @@
+---
+products: oss-enterprise, cloud-teams
+---
+
 # Single Sign-On (SSO)
 
 import Tabs from "@theme/Tabs";

diff --git a/docs/api-documentation.md b/docs/api-documentation.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # API documentation
 
 Airbyte has two sets of APIs which are intended for different uses. The table below outlines their descriptions, use cases, availability and status.

diff --git a/docs/cli-documentation.md b/docs/cli-documentation.md
@@ -1,3 +1,7 @@
+---
+products: oss-community
+---
+
 # CLI documentation
 
 :::caution

diff --git a/docs/cloud/managing-airbyte-cloud/configuring-connections.md b/docs/cloud/managing-airbyte-cloud/configuring-connections.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # Configuring connections
 
 A connection links a source to a destination and defines how your data will sync. After you have created a connection, you can modify any of the configuration settings or stream settings.

diff --git a/docs/cloud/managing-airbyte-cloud/dbt-cloud-integration.md b/docs/cloud/managing-airbyte-cloud/dbt-cloud-integration.md
@@ -1,6 +1,8 @@
-# Use the dbt Cloud integration 
+---
+products: cloud
+---
 
-<AppliesTo cloud />
+# Use the dbt Cloud integration 
 
 By using the dbt Cloud integration, you can create and run dbt transformations during syncs in Airbyte Cloud. This allows you to transform raw data into a format that is suitable for analysis and reporting, including cleaning and enriching the data. 
 

diff --git a/docs/cloud/managing-airbyte-cloud/manage-airbyte-cloud-notifications.md b/docs/cloud/managing-airbyte-cloud/manage-airbyte-cloud-notifications.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # Manage notifications
 
 This page provides guidance on how to manage notifications for Airbyte, allowing you to stay up-to-date on the activities in your workspace. 

diff --git a/docs/cloud/managing-airbyte-cloud/manage-connection-state.md b/docs/cloud/managing-airbyte-cloud/manage-connection-state.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # Manage the connection state
 
 The connection state provides additional information about incremental syncs. It includes the most recent values for the global or stream-level cursors, which can aid in debugging or determining which data will be included in the next sync. 

diff --git a/docs/cloud/managing-airbyte-cloud/manage-credits.md b/docs/cloud/managing-airbyte-cloud/manage-credits.md
@@ -1,6 +1,8 @@
-# Manage credits
+---
+products: cloud
+---
 
-<AppliesTo cloud />
+# Manage credits
 
 Airbyte [credits](https://airbyte.com/pricing) are used to pay for Airbyte resources when you run a sync. You can purchase credits on Airbyte Cloud to keep your data flowing without interruption. 
 

diff --git a/docs/cloud/managing-airbyte-cloud/manage-data-residency.md b/docs/cloud/managing-airbyte-cloud/manage-data-residency.md
@@ -1,6 +1,8 @@
-# Manage data residency
+---
+products: cloud
+---
 
-<AppliesTo cloud />
+# Manage data residency
 
 In Airbyte Cloud, you can set the default data residency and choose the data residency for individual connections, which can help you comply with data localization requirements.
 

diff --git a/docs/cloud/managing-airbyte-cloud/manage-schema-changes.md b/docs/cloud/managing-airbyte-cloud/manage-schema-changes.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # Manage schema changes
 
 You can specify for each connection how Airbyte should handle any change of schema in the source. This process helps ensure accurate and efficient data syncs, minimizing errors and saving you time and effort in managing your data pipelines.

diff --git a/docs/cloud/managing-airbyte-cloud/review-connection-status.md b/docs/cloud/managing-airbyte-cloud/review-connection-status.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # Review the connection status
 The connection status displays information about the connection and of each stream being synced. Reviewing this summary allows you to assess the connection's current status and understand when the next sync will be run.
 

diff --git a/docs/cloud/managing-airbyte-cloud/review-sync-history.md b/docs/cloud/managing-airbyte-cloud/review-sync-history.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # Review the sync history
 
 The job history displays information about synced data, such as the amount of data moved, the number of records read and committed, and the total sync time. Reviewing this summary can help you monitor the sync performance and identify any potential issues.  

diff --git a/docs/cloud/managing-airbyte-cloud/understand-airbyte-cloud-limits.md b/docs/cloud/managing-airbyte-cloud/understand-airbyte-cloud-limits.md
@@ -1,3 +1,7 @@
+---
+products: cloud
+---
+
 # Airbyte Cloud limits
 
 Understanding the following limitations will help you more effectively manage Airbyte Cloud.

diff --git a/docs/community/getting-support.md b/docs/community/getting-support.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # Getting Support
 
 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!

diff --git a/docs/enterprise-setup/README.md b/docs/enterprise-setup/README.md
@@ -1,3 +1,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 300+ pre-built connectors, data never leaves your environment, and Airbyte becomes self-serve in your organization with new tools to manage multiple users, and multiple teams using Airbyte all in one place.

diff --git a/docs/enterprise-setup/implementation-guide.md b/docs/enterprise-setup/implementation-guide.md
@@ -1,3 +1,7 @@
+---
+products: oss-enterprise
+---
+
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 

diff --git a/docs/enterprise-setup/upgrading-from-community.md b/docs/enterprise-setup/upgrading-from-community.md
@@ -1,3 +1,7 @@
+---
+products: oss-enterprise
+---
+
 # 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). 

diff --git a/docs/integrations/connector-support-levels.md b/docs/integrations/connector-support-levels.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # Connector Support Levels
 
 The following table describes the support levels of Airbyte connectors.

diff --git a/docs/operating-airbyte/security.md b/docs/operating-airbyte/security.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # Security
 
 Airbyte is committed to keeping your data safe by following industry-standard practices for securing physical deployments, setting access policies, and leveraging the security features of leading Cloud providers.

diff --git a/docs/operator-guides/browsing-output-logs.md b/docs/operator-guides/browsing-output-logs.md
@@ -1,6 +1,8 @@
-# Browsing Logs
+---
+products: all
+---
 
-## Overview
+# Browsing Logs
 
 Airbyte records the full logs as a part of each sync. These logs can be used to understand the underlying operations Airbyte performs to read data from the source and write to the destination as a part of the [Airbyte Protocol](/understanding-airbyte/airbyte-protocol.md). The logs includes many details, including any errors that can be helpful when troubleshooting sync errors. 
 

diff --git a/docs/operator-guides/collecting-metrics.md b/docs/operator-guides/collecting-metrics.md
@@ -1,3 +1,7 @@
+---
+products: oss-*
+---
+
 # Monitoring Airbyte
 
 

diff --git a/docs/operator-guides/configuring-airbyte-db.md b/docs/operator-guides/configuring-airbyte-db.md
@@ -1,3 +1,7 @@
+---
+products: oss-*
+---
+
 # Configuring the Airbyte Database
 
 Airbyte uses different objects to store internal state and metadata. This data is stored and manipulated by the various Airbyte components, but you have the ability to manage the deployment of this database in the following two ways:

diff --git a/docs/operator-guides/configuring-airbyte.md b/docs/operator-guides/configuring-airbyte.md
@@ -1,3 +1,7 @@
+---
+products: oss-*
+---
+
 # Configuring Airbyte
 
 This section covers how to configure Airbyte, and the various configuration Airbyte accepts.

diff --git a/docs/operator-guides/configuring-connector-resources.md b/docs/operator-guides/configuring-connector-resources.md
@@ -1,3 +1,7 @@
+---
+products: oss-*
+---
+
 # Configuring Connector Resources
 
 As noted in [Workers & Jobs](../understanding-airbyte/jobs.md), there are four different types of jobs.

diff --git a/docs/operator-guides/reset.md b/docs/operator-guides/reset.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # Resetting Your Data
 
 Resetting your data allows you to drop all previously synced data so that any ensuing sync can start syncing fresh. This is useful if you don't require the data replicated to your destination to be saved permanently or are just testing Airbyte.

diff --git a/docs/operator-guides/scaling-airbyte.md b/docs/operator-guides/scaling-airbyte.md
@@ -1,3 +1,7 @@
+---
+products: oss-*
+---
+
 # Scaling Airbyte
 
 As depicted in our [High-Level View](../understanding-airbyte/high-level-view.md), Airbyte is made up of several components under the hood: 1. Scheduler 2. Server 3. Temporal 4. Webapp 5. Database

diff --git a/...perator-guides/transformation-and-normalization/transformations-with-airbyte.md b/...perator-guides/transformation-and-normalization/transformations-with-airbyte.md
@@ -1,6 +1,8 @@
-# Transformations with Airbyte (Part 3/3)
+---
+products: oss-*
+---
 
-## Overview
+# Transformations with Airbyte (Part 3/3)
 
 This tutorial will describe how to push a custom dbt transformation project back to Airbyte to use during syncs.
 

diff --git a/docs/operator-guides/transformation-and-normalization/transformations-with-dbt.md b/docs/operator-guides/transformation-and-normalization/transformations-with-dbt.md
@@ -1,6 +1,8 @@
-# Transformations with dbt (Part 2/3)
+---
+products: oss-*
+---
 
-## Overview
+# Transformations with dbt (Part 2/3)
 
 This tutorial will describe how to integrate SQL based transformations with Airbyte syncs using specialized transformation tool: dbt.
 

diff --git a/docs/operator-guides/transformation-and-normalization/transformations-with-sql.md b/docs/operator-guides/transformation-and-normalization/transformations-with-sql.md
@@ -1,8 +1,8 @@
-# Transformations with SQL (Part 1/3)
-
-## Transformations with SQL \(Part 1/3\)
+---
+products: oss-*
+---
 
-### Overview
+# Transformations with SQL (Part 1/3)
 
 This tutorial will describe how to integrate SQL based transformations with Airbyte syncs using plain SQL queries.
 

diff --git a/docs/operator-guides/upgrading-airbyte.md b/docs/operator-guides/upgrading-airbyte.md
@@ -1,3 +1,7 @@
+---
+products: oss-*
+---
+
 # Upgrading Airbyte
 
 :::info

diff --git a/docs/operator-guides/using-custom-connectors.md b/docs/operator-guides/using-custom-connectors.md
@@ -1,4 +1,5 @@
----  
+---
+products: oss-*
 sidebar_label: Uploading custom connectors 
 --- 
 

diff --git a/docs/operator-guides/using-dagster-integration.md b/docs/operator-guides/using-dagster-integration.md
@@ -1,5 +1,6 @@
 ---
 description: Start triggering Airbyte jobs with Dagster in minutes
+products: oss-*
 ---
 
 # Using the Dagster Integration 

diff --git a/docs/operator-guides/using-kestra-plugin.md b/docs/operator-guides/using-kestra-plugin.md
@@ -1,5 +1,6 @@
 ---
 description: Using the Kestra Plugin to Orchestrate Airbyte
+products: oss-*
 ---
 
 # Using the Kestra Plugin

diff --git a/docs/operator-guides/using-prefect-task.md b/docs/operator-guides/using-prefect-task.md
@@ -1,5 +1,6 @@
 ---
 description: Start triggering Airbyte jobs with Prefect in minutes
+products: oss-*
 ---
 
 # Using the Prefect Airbyte Task

diff --git a/docs/operator-guides/using-the-airflow-airbyte-operator.md b/docs/operator-guides/using-the-airflow-airbyte-operator.md
@@ -1,5 +1,6 @@
 ---
 description: Start triggering Airbyte jobs with Apache Airflow in minutes
+products: oss-*
 ---
 
 # Using the Airbyte Operator to orchestrate Airbyte OSS

diff --git a/docs/terraform-documentation.md b/docs/terraform-documentation.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # Terraform Documentation
 
 Airbyte's Terraform provider enables you to automate & version-control your Airbyte configuration as code. Save time managing Airbyte and collaborate on Airbyte configuration changes with your teammates. Airbyte's Terraform provider is built off our [Airbyte API](https://api.airbyte.com). 

diff --git a/docs/using-airbyte/core-concepts/basic-normalization.md b/docs/using-airbyte/core-concepts/basic-normalization.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # Basic Normalization
 
 :::danger

diff --git a/docs/using-airbyte/core-concepts/namespaces.md b/docs/using-airbyte/core-concepts/namespaces.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # Namespaces
 
 ## High-Level Overview

diff --git a/docs/using-airbyte/core-concepts/readme.md b/docs/using-airbyte/core-concepts/readme.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # Core Concepts
 
 Airbyte enables you to build data pipelines and replicate data from a source to a destination. You can configure how frequently the data is synced, what data is replicated, and how the data is written to in the destination.

diff --git a/docs/using-airbyte/core-concepts/sync-modes/README.md b/docs/using-airbyte/core-concepts/sync-modes/README.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # Sync Modes
 
 A sync mode governs how Airbyte reads from a source and writes to a destination. Airbyte provides different sync modes to account for various use cases. To minimize confusion, a mode's behavior is reflected in its name. The easiest way to understand Airbyte's sync modes is to understand how the modes are named.

diff --git a/docs/using-airbyte/core-concepts/sync-modes/full-refresh-append.md b/docs/using-airbyte/core-concepts/sync-modes/full-refresh-append.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # Full Refresh - Append
 
 ## Overview

diff --git a/docs/using-airbyte/core-concepts/sync-modes/full-refresh-overwrite.md b/docs/using-airbyte/core-concepts/sync-modes/full-refresh-overwrite.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # Full Refresh - Overwrite
 
 ## Overview

diff --git a/docs/using-airbyte/core-concepts/sync-modes/incremental-append-deduped.md b/docs/using-airbyte/core-concepts/sync-modes/incremental-append-deduped.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # Incremental Sync - Append + Deduped
 
 ## High-Level Context

diff --git a/docs/using-airbyte/core-concepts/sync-modes/incremental-append.md b/docs/using-airbyte/core-concepts/sync-modes/incremental-append.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # Incremental Sync - Append
 
 ## Overview

diff --git a/docs/using-airbyte/core-concepts/sync-schedules.md b/docs/using-airbyte/core-concepts/sync-schedules.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # Sync Schedules
 
 For each connection, you can select between three options that allow a sync to run. The three options for `Replication Frequency` are:

diff --git a/docs/using-airbyte/core-concepts/typing-deduping.md b/docs/using-airbyte/core-concepts/typing-deduping.md
@@ -1,3 +1,7 @@
+---
+products: all
+---
+
 # Typing and Deduping
 
 This page refers to new functionality added by [Destinations V2](/release_notes/upgrading_to_destinations_v2/). Typing and deduping is the default method of transforming datasets within data warehouse and database destinations after they've been replicated. Please check each destination to learn if Typing and Deduping is supported.