docs: fix pages with multiple H1 headings (#70310)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Ian Alton <ian.alton@airbyte.io> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
5fb70f1b9f
commit
6f3a9d89f6
@@ -37,8 +37,7 @@ To use the deepset destination in Airbyte:
|
||||
|
||||
After you connect a source and the first stream synchronization succeeds, your records are available in deepset AI Platform on the Files page as Markdown files.
|
||||
|
||||
# Changelog
|
||||
|
||||
## Changelog
|
||||
|
||||
<details>
|
||||
<summary>Expand to review</summary>
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
This page guides you through setting up a [Fauna](https://fauna.com/) source.
|
||||
|
||||
# Overview
|
||||
## Overview
|
||||
|
||||
The Fauna source supports the following sync modes:
|
||||
|
||||
|
||||
@@ -2,16 +2,16 @@
|
||||
|
||||
This page guides you through the process of setting up the Kafka source connector.
|
||||
|
||||
# Set up guide
|
||||
## Set up guide
|
||||
|
||||
## Step 1: Set up Kafka
|
||||
### Step 1: Set up Kafka
|
||||
|
||||
To use the Kafka source connector, you'll need:
|
||||
|
||||
- [A Kafka cluster 1.0 or above](https://kafka.apache.org/quickstart)
|
||||
- Airbyte user should be allowed to read messages from topics, and these topics should be created before reading from Kafka.
|
||||
|
||||
## Step 2: Setup the Kafka source in Airbyte
|
||||
### Step 2: Setup the Kafka source in Airbyte
|
||||
|
||||
You'll need the following information to configure the Kafka source:
|
||||
|
||||
@@ -39,7 +39,7 @@ Some optional fields that are recommended to set according to your use
|
||||
- **Test Topic** - The Topic to test whether Airbyte can consume messages. (e.g. test.topic)
|
||||
- **Polling Time** - Amount of time in milliseconds Kafka connector should try to poll for messages, per sync
|
||||
|
||||
### For Airbyte Open Source:
|
||||
#### For Airbyte Open Source
|
||||
|
||||
1. Go to the Airbyte UI and in the left navigation bar, click **Sources**. In the top-right corner, click **+new source**.
|
||||
2. On the Set up the source page, enter the name for the Kafka connector and select **Kafka** from the Source type dropdown.
|
||||
|
||||
@@ -10,7 +10,7 @@ Webflow uses [Collections](https://developers.webflow.com/#collections) to store
|
||||
|
||||
This connector dynamically figures out which collections are available, creates the schema for each collection based on data extracted from Webflow, and creates an [Airbyte Stream](https://docs.airbyte.com/connector-development/cdk-python/full-refresh-stream/) for each collection.
|
||||
|
||||
# Webflow credentials
|
||||
## Webflow credentials
|
||||
|
||||
You should be able to create a Webflow `API key` (aka `API token`) as described in [Intro to the Webflow API](https://university.webflow.com/lesson/intro-to-the-webflow-api). The Webflow connector uses the Webflow API v1 and therefore will require a legacy v1 API key.
|
||||
|
||||
@@ -30,7 +30,7 @@ Which should respond with something similar to:
|
||||
|
||||
You will need to provide the `Site ID` and `API key` to the Webflow connector in order for it to pull data from your Webflow site.
|
||||
|
||||
# Related tutorial
|
||||
## Related tutorial
|
||||
|
||||
If you are interested in learning more about the Webflow API and implementation details of this connector, you may wish to consult the [tutorial about how to build a connector to extract data from the Webflow API](https://airbyte.com/tutorials/extract-data-from-the-webflow-api).
|
||||
|
||||
|
||||
@@ -111,9 +111,9 @@ You can pull your connector image from your private registry to validate the pre
|
||||
|
||||
5. `Add` the connector to save the configuration. You can now select your new connector when setting up a new connection!
|
||||
|
||||
# Troubleshooting
|
||||
## Troubleshooting
|
||||
|
||||
## Loading connector docker containers into kind
|
||||
### Loading connector docker containers into kind
|
||||
|
||||
If you are running Airbyte in kind (kubernetes in docker -- this is the default method for abctl), you must load the docker image of that connector into the cluster. If you are seeing the following error, it likely means that the docker image has not been properly loaded into the cluster.
|
||||
|
||||
|
||||
@@ -111,9 +111,9 @@ You can pull your connector image from your private registry to validate the pre
|
||||
|
||||
5. `Add` the connector to save the configuration. You can now select your new connector when setting up a new connection!
|
||||
|
||||
# Troubleshooting
|
||||
## Troubleshooting
|
||||
|
||||
## Loading connector docker containers into kind
|
||||
### Loading connector docker containers into kind
|
||||
|
||||
If you are running Airbyte in kind (kubernetes in docker -- this is the default method for abctl), you must load the docker image of that connector into the cluster. If you are seeing the following error, it likely means that the docker image has not been properly loaded into the cluster.
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ The Airbyte API enables you to programmatically interact with Airbyte: create so
|
||||
|
||||
Access to the API is controlled through application keys. Applications keys are tied to individual users and their respective permissions.
|
||||
|
||||
# Prerequisites
|
||||
## Prerequisites
|
||||
|
||||
<Tabs groupId="cloud-hosted">
|
||||
<TabItem value="cloud" label="Cloud">
|
||||
@@ -23,7 +23,7 @@ Access to the API is controlled through application keys. Applications keys are
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Step 1: Create an Application
|
||||
### Step 1: Create an Application
|
||||
|
||||
While logged into the Airbyte UI, go to Settings -> Account -> Applications. Click the button "Create an application".
|
||||
|
||||
@@ -37,7 +37,7 @@ A `client_id` and `client_secret` will be automatically generated. The `client_s
|
||||
|
||||

|
||||
|
||||
## Step 2: Obtain an Access Token
|
||||
### Step 2: Obtain an Access Token
|
||||
|
||||
Once the `client_secret` is exposed, you can use the button in the UI to get an access token to do a quick test.
|
||||
|
||||
@@ -85,7 +85,7 @@ The API response should provide an `access_token`, which is a Bearer Token valid
|
||||
Access tokens are short-lived (3 minutes) so we recommend fetching a new token before each request. The Terraform Provider/SDKs properly handle this for you if you initialize the Provider/SDK with the Client Credentials grant type using your Application's `client_id` and `client_secret`.
|
||||
:::
|
||||
|
||||
## Step 3: Operate Airbyte via API
|
||||
### Step 3: Operate Airbyte via API
|
||||
|
||||
You may now make requests to any endpoint documented in our [Airbyte API Reference](https://reference.airbyte.com). For example, you may use the [List workspaces endpoint](https://reference.airbyte.com/reference/listworkspaces) to verify the list of workspaces in your organization. Ensure to include your `access_token` as a `Bearer Token` in your request.:
|
||||
|
||||
|
||||
@@ -111,9 +111,9 @@ You can pull your connector image from your private registry to validate the pre
|
||||
|
||||
5. `Add` the connector to save the configuration. You can now select your new connector when setting up a new connection!
|
||||
|
||||
# Troubleshooting
|
||||
## Troubleshooting
|
||||
|
||||
## Loading connector docker containers into kind
|
||||
### Loading connector docker containers into kind
|
||||
|
||||
If you are running Airbyte in kind (kubernetes in docker -- this is the default method for abctl), you must load the docker image of that connector into the cluster. If you are seeing the following error, it likely means that the docker image has not been properly loaded into the cluster.
|
||||
|
||||
|
||||
@@ -9,9 +9,10 @@ import TabItem from "@theme/TabItem";
|
||||
|
||||
The Airbyte API enables you to programmatically interact with Airbyte: create sources, destinations, run syncs, list workspaces, and much more.
|
||||
|
||||
Access to the API is controlled through application keys. Applications keys are tied to individual users and their respective permissions.
|
||||
Access to the API is controlled through application keys. Applications keys are tied to individual users and their respective permissions.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
# Prerequisites
|
||||
<Tabs groupId="cloud-hosted">
|
||||
<TabItem value="cloud" label="Cloud">
|
||||
Access to a Cloud workspace.
|
||||
@@ -22,9 +23,9 @@ Access to the API is controlled through application keys. Applications keys are
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Step 1: Create an Application
|
||||
### Step 1: Create an Application
|
||||
|
||||
While logged into the Airbyte UI, go to Settings -> Account -> Applications. Click the button "Create an application".
|
||||
While logged into the Airbyte UI, go to Settings -> Account -> Applications. Click the button "Create an application".
|
||||
|
||||

|
||||
|
||||
@@ -37,9 +38,9 @@ A `client_id` and `client_secret` will be automatically generated. The `client_s
|
||||
|
||||

|
||||
|
||||
## Step 2: Obtain an Access Token
|
||||
### Step 2: Obtain an Access Token
|
||||
|
||||
Once the `client_secret` is exposed, you can use the button in the UI to get an access token to do a quick test.
|
||||
Once the `client_secret` is exposed, you can use the button in the UI to get an access token to do a quick test.
|
||||
|
||||
You can also use the `client_id` and `client_secret` to retrive an access token using the [Get an Access Token endpoint](https://reference.airbyte.com/reference/createaccesstoken).
|
||||
|
||||
@@ -85,7 +86,7 @@ The API response should provide an `access_token`, which is a Bearer Token valid
|
||||
Access tokens are short-lived (3 minutes) so we recommend fetching a new token before each request. The Terraform Provider/SDKs properly handle this for you if you initialize the Provider/SDK with the Client Credentials grant type using your Application's `client_id` and `client_secret`.
|
||||
:::
|
||||
|
||||
## Step 3: Operate Airbyte via API
|
||||
### Step 3: Operate Airbyte via API
|
||||
|
||||
You may now make requests to any endpoint documented in our [Airbyte API Reference](https://reference.airbyte.com). For example, you may use the [List workspaces endpoint](https://reference.airbyte.com/reference/listworkspaces) to verify the list of workspaces in your organization. Ensure to include your `access_token` as a `Bearer Token` in your request.:
|
||||
|
||||
|
||||
@@ -111,9 +111,9 @@ You can pull your connector image from your private registry to validate the pre
|
||||
|
||||
5. `Add` the connector to save the configuration. You can now select your new connector when setting up a new connection!
|
||||
|
||||
# Troubleshooting
|
||||
## Troubleshooting
|
||||
|
||||
## Loading connector docker containers into kind
|
||||
### Loading connector docker containers into kind
|
||||
|
||||
If you are running Airbyte in kind (kubernetes in docker -- this is the default method for abctl), you must load the docker image of that connector into the cluster. If you are seeing the following error, it likely means that the docker image has not been properly loaded into the cluster.
|
||||
|
||||
|
||||
@@ -9,9 +9,10 @@ import TabItem from "@theme/TabItem";
|
||||
|
||||
The Airbyte API enables you to programmatically interact with Airbyte: create sources, destinations, run syncs, list workspaces, and much more.
|
||||
|
||||
Access to the API is controlled through application keys. Applications keys are tied to individual users and their respective permissions.
|
||||
Access to the API is controlled through application keys. Applications keys are tied to individual users and their respective permissions.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
# Prerequisites
|
||||
<Tabs groupId="cloud-hosted">
|
||||
<TabItem value="cloud" label="Cloud">
|
||||
Access to a Cloud workspace.
|
||||
@@ -22,9 +23,9 @@ Access to the API is controlled through application keys. Applications keys are
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Step 1: Create an Application
|
||||
### Step 1: Create an Application
|
||||
|
||||
While logged into the Airbyte UI, go to Settings -> Account -> Applications. Click the button "Create an application".
|
||||
While logged into the Airbyte UI, go to Settings -> Account -> Applications. Click the button "Create an application".
|
||||
|
||||

|
||||
|
||||
@@ -37,9 +38,9 @@ A `client_id` and `client_secret` will be automatically generated. The `client_s
|
||||
|
||||

|
||||
|
||||
## Step 2: Obtain an Access Token
|
||||
### Step 2: Obtain an Access Token
|
||||
|
||||
Once the `client_secret` is exposed, you can use the button in the UI to get an access token to do a quick test.
|
||||
Once the `client_secret` is exposed, you can use the button in the UI to get an access token to do a quick test.
|
||||
|
||||
You can also use the `client_id` and `client_secret` to retrive an access token using the [Get an Access Token endpoint](https://reference.airbyte.com/reference/createaccesstoken).
|
||||
|
||||
@@ -85,7 +86,7 @@ The API response should provide an `access_token`, which is a Bearer Token valid
|
||||
Access tokens are short-lived (3 minutes) so we recommend fetching a new token before each request. The Terraform Provider/SDKs properly handle this for you if you initialize the Provider/SDK with the Client Credentials grant type using your Application's `client_id` and `client_secret`.
|
||||
:::
|
||||
|
||||
## Step 3: Operate Airbyte via API
|
||||
### Step 3: Operate Airbyte via API
|
||||
|
||||
You may now make requests to any endpoint documented in our [Airbyte API Reference](https://reference.airbyte.com). For example, you may use the [List workspaces endpoint](https://reference.airbyte.com/reference/listworkspaces) to verify the list of workspaces in your organization. Ensure to include your `access_token` as a `Bearer Token` in your request.:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user