Skip to content

Commit af7059c

Browse files
committed
fix yaml
1 parent 8aef3b2 commit af7059c

File tree

15 files changed

+73
-76
lines changed

15 files changed

+73
-76
lines changed

connectors/database/adls-datalake/yaml.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,31 +70,31 @@ Configure the source type and service name for your ADLS Datalake connector.
7070

7171
</ContentSection>
7272

73-
<ContentSection id={3} title="Azure Configuration" lines="10">
73+
<ContentSection id={3} title="Azure Configuration" lines="10-15">
7474

7575
<AzureConfigDef />
7676

7777
</ContentSection>
7878

79-
<ContentSection id={4} title="Prefix" lines="11">
79+
<ContentSection id={4} title="Prefix" lines="16">
8080

8181
**prefix**: Prefix path for the data lake files.
8282

8383
</ContentSection>
8484

85-
<ContentSection id={5} title="Source Config" lines="12">
85+
<ContentSection id={5} title="Source Config" lines="17">
8686

8787
<SourceConfigDef />
8888

8989
</ContentSection>
9090

91-
<ContentSection id={6} title="Sink Configuration" lines="13">
91+
<ContentSection id={6} title="Sink Configuration" lines="18">
9292

9393
<IngestionSinkDef />
9494

9595
</ContentSection>
9696

97-
<ContentSection id={7} title="Workflow Configuration" lines="14">
97+
<ContentSection id={7} title="Workflow Configuration" lines="19">
9898

9999
<WorkflowConfigDef />
100100

connectors/database/athena/yaml.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -174,31 +174,31 @@ Configure the source type and service name for your Athena connector.
174174

175175
</ContentSection>
176176

177-
<ContentSection id={3} title="AWS Configuration" lines="8">
177+
<ContentSection id={3} title="AWS Configuration" lines="8-16">
178178

179179
<AwsConfigDef />
180180

181181
</ContentSection>
182182

183-
<ContentSection id={4} title="S3 Staging Directory" lines="9">
183+
<ContentSection id={4} title="S3 Staging Directory" lines="17">
184184

185185
**s3StagingDir**: The S3 staging directory is an optional parameter. Enter a staging directory to override the default staging directory for AWS Athena.
186186

187187
</ContentSection>
188188

189-
<ContentSection id={5} title="Workgroup" lines="10">
189+
<ContentSection id={5} title="Workgroup" lines="18">
190190

191191
**workgroup**: The Athena workgroup is an optional parameter. If you wish to have your Athena connection related to an existing AWS workgroup add your workgroup name here.
192192

193193
</ContentSection>
194194

195-
<ContentSection id={6} title="Connection Options" lines="11-12">
195+
<ContentSection id={6} title="Connection Options" lines="19-20">
196196

197197
**Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to database during the connection. These details must be added as Key-Value pairs.
198198

199199
</ContentSection>
200200

201-
<ContentSection id={7} title="Connection Arguments" lines="13-14">
201+
<ContentSection id={7} title="Connection Arguments" lines="21-22">
202202

203203
**Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent to database during the connection. These details must be added as Key-Value pairs.
204204

connectors/database/bigquery/yaml.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -97,15 +97,15 @@ Configure the source type and service name for your BigQuery connector.
9797

9898
</ContentSection>
9999

100-
<ContentSection id={3} title="Credentials" lines="8-9">
100+
<ContentSection id={3} title="Credentials" lines="7-8">
101101

102102
**credentials**: You can authenticate with your BigQuery instance using either `GCP Credentials Path` where you can specify the file path of the service account key or you can pass the values directly by choosing the `GCP Credentials Values` from the service account key file.
103103

104104
You can checkout [this](https://cloud.google.com/iam/docs/keys-create-delete#iam-service-account-keys-create-console) documentation on how to create the service account keys and download it.
105105

106106
</ContentSection>
107107

108-
<ContentSection id={4} title="GCP Configuration" lines="10">
108+
<ContentSection id={4} title="GCP Configuration" lines="9-21">
109109

110110
<div>
111111

@@ -149,7 +149,7 @@ credentials:
149149
150150
</ContentSection>
151151
152-
<ContentSection id={5} title="Taxonomy Configuration" lines="11-12">
152+
<ContentSection id={5} title="Taxonomy Configuration" lines="22-23">
153153
154154
<div>
155155
@@ -167,33 +167,33 @@ If you have attached policy tags to the columns of table available in BigQuery,
167167
168168
</ContentSection>
169169
170-
<ContentSection id={6} title="Usage Location" lines="13">
170+
<ContentSection id={6} title="Usage Location" lines="24">
171171
172172
**Usage Location (Optional)**: Location used to query `INFORMATION_SCHEMA.JOBS_BY_PROJECT` to fetch usage data. You can pass multi-regions, such as `us` or `eu`, or your specific region such as `us-east1`. Australia and Asia multi-regions are not yet supported.
173173

174174
</ContentSection>
175175

176-
<ContentSection id={7} title="Cost Per TiB" lines="14">
176+
<ContentSection id={7} title="Cost Per TiB" lines="25">
177177

178178
**Cost Per TiB (Optional)**: The cost (in USD) per tebibyte (TiB) of data processed during BigQuery usage analysis. This value is used to estimate query costs when analyzing usage metrics from `INFORMATION_SCHEMA.JOBS_BY_PROJECT`.
179179

180180
This setting does **not** affect actual billing—it is only used for internal reporting and visualization of estimated costs. The default value, if not set, may assume the standard on-demand BigQuery pricing (e.g., $5.00 per TiB), but you should adjust it according to your organization's negotiated rates or flat-rate pricing model.
181181

182182
</ContentSection>
183183

184-
<ContentSection id={8} title="Billing Project ID" lines="15">
184+
<ContentSection id={8} title="Billing Project ID" lines="26">
185185

186186
**Billing Project ID (Optional)**: A billing project ID is a unique string used to identify and authorize your project for billing in Google Cloud.
187187

188188
</ContentSection>
189189

190-
<ContentSection id={9} title="Connection Options" lines="16-17">
190+
<ContentSection id={9} title="Connection Options" lines="27-28">
191191

192192
**Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to database during the connection. These details must be added as Key-Value pairs.
193193

194194
</ContentSection>
195195

196-
<ContentSection id={10} title="Connection Arguments" lines="18-19">
196+
<ContentSection id={10} title="Connection Arguments" lines="29-30">
197197

198198
**Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent to database during the connection. These details must be added as Key-Value pairs.
199199

connectors/database/bigtable/yaml.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ You can checkout [this](https://cloud.google.com/iam/docs/keys-create-delete#iam
7777

7878
</ContentSection>
7979

80-
<ContentSection id={4} title="GCP Configuration" lines="10">
80+
<ContentSection id={4} title="GCP Configuration" lines="10-22">
8181

8282
<div>
8383

@@ -98,13 +98,13 @@ You can checkout [this](https://cloud.google.com/iam/docs/keys-create-delete#iam
9898

9999
</ContentSection>
100100

101-
<ContentSection id={5} title="Connection Options" lines="11-12">
101+
<ContentSection id={5} title="Connection Options" lines="23-24">
102102

103103
**Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to database during the connection. These details must be added as Key-Value pairs.
104104

105105
</ContentSection>
106106

107-
<ContentSection id={6} title="Connection Arguments" lines="13-14">
107+
<ContentSection id={6} title="Connection Arguments" lines="25-26">
108108

109109
**Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent to database during the connection. These details must be added as Key-Value pairs.
110110

connectors/database/dynamodb/yaml.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,25 +76,25 @@ Configure the source type and service name for your DynamoDB connector.
7676

7777
</ContentSection>
7878

79-
<ContentSection id={2} title="AWS Configuration" lines="7">
79+
<ContentSection id={2} title="AWS Configuration" lines="7-16">
8080

8181
<AwsConfigDef />
8282

8383
</ContentSection>
8484

85-
<ContentSection id={3} title="Database Name" lines="8">
85+
<ContentSection id={3} title="Database Name" lines="17">
8686

8787
**databaseName**: Optional name to give to the database in OpenMetadata. If left blank, we will use default as the database name.
8888

8989
</ContentSection>
9090

91-
<ContentSection id={4} title="Connection Options" lines="9-10">
91+
<ContentSection id={4} title="Connection Options" lines="18-19">
9292

9393
**Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to database during the connection. These details must be added as Key-Value pairs.
9494

9595
</ContentSection>
9696

97-
<ContentSection id={5} title="Connection Arguments" lines="11-12">
97+
<ContentSection id={5} title="Connection Arguments" lines="20-21">
9898

9999
**Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent to database during the connection. These details must be added as Key-Value pairs.
100100

connectors/database/gcs-datalake/yaml.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,33 +61,33 @@ Configure the source type and service name for your GCS Datalake connector.
6161

6262
</ContentSection>
6363

64-
<ContentSection id={2} title="GCP Configuration" lines="7-8">
64+
<ContentSection id={2} title="GCP Configuration" lines="7-19">
6565

6666
<GcpConfigDef />
6767

6868
</ContentSection>
6969

70-
<ContentSection id={3} title="Bucket Configuration" lines="9-10">
70+
<ContentSection id={3} title="Bucket Configuration" lines="20-21">
7171

7272
**bucketName**: name of the bucket in GCS
7373

7474
**Prefix**: prefix in gcp bucket
7575

7676
</ContentSection>
7777

78-
<ContentSection id={4} title="Source Config" lines="11-13">
78+
<ContentSection id={4} title="Source Config" lines="22-24">
7979

8080
<SourceConfigDef />
8181

8282
</ContentSection>
8383

84-
<ContentSection id={5} title="Sink Configuration" lines="14-16">
84+
<ContentSection id={5} title="Sink Configuration" lines="25-27">
8585

8686
<IngestionSinkDef />
8787

8888
</ContentSection>
8989

90-
<ContentSection id={6} title="Workflow Configuration" lines="17-33">
90+
<ContentSection id={6} title="Workflow Configuration" lines="28-44">
9191

9292
<WorkflowConfigDef />
9393

connectors/database/glue/yaml.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,25 +60,25 @@ Configure the source type and service name for your Glue connector.
6060

6161
</ContentSection>
6262

63-
<ContentSection id={2} title="AWS Configuration" lines="7">
63+
<ContentSection id={2} title="AWS Configuration" lines="7-16">
6464

6565
<AwsConfigDef />
6666

6767
</ContentSection>
6868

69-
<ContentSection id={3} title="Database Name" lines="8">
69+
<ContentSection id={3} title="Database Name" lines="17">
7070

7171
**databaseName**: Optional name to give to the database in OpenMetadata. If left blank, we will use [Glue Catalog ID](https://docs.aws.amazon.com/glue/latest/dg/glue-specifying-resource-arns.html#data-catalog-resource-arns) as the database name.
7272

7373
</ContentSection>
7474

75-
<ContentSection id={4} title="Connection Options" lines="9-10">
75+
<ContentSection id={4} title="Connection Options" lines="18-19">
7676

7777
**Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to database during the connection. These details must be added as Key-Value pairs.
7878

7979
</ContentSection>
8080

81-
<ContentSection id={5} title="Connection Arguments" lines="11-12">
81+
<ContentSection id={5} title="Connection Arguments" lines="20-21">
8282

8383
**Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent to database during the connection. These details must be added as Key-Value pairs.
8484

connectors/database/s3-datalake/yaml.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,27 +85,27 @@ Configure the source type and service name for your S3 Datalake connector.
8585

8686
</ContentSection>
8787

88-
<ContentSection id={2} title="Security Config" lines="7-8">
88+
<ContentSection id={2} title="Security Config" lines="7-17">
8989

9090
**configSource**: Configure the security settings for connecting to AWS S3.
9191

9292
<AwsConfigDef />
9393

9494
</ContentSection>
9595

96-
<ContentSection id={3} title="Bucket Name" lines="9">
96+
<ContentSection id={3} title="Bucket Name" lines="18">
9797

9898
**bucketName**: Name of the S3 bucket to connect to.
9999

100100
</ContentSection>
101101

102-
<ContentSection id={4} title="Prefix" lines="10">
102+
<ContentSection id={4} title="Prefix" lines="19">
103103

104104
**prefix**: Prefix path within the S3 bucket.
105105

106106
</ContentSection>
107107

108-
<ContentSection id={5} title="Filter Patterns" lines="11-12">
108+
<ContentSection id={5} title="Filter Patterns" lines="20-21">
109109

110110
**schemaFilterPattern** and **tableFilterPattern**: Note that the `schemaFilterPattern` and `tableFilterPattern` both support regex as `include` or `exclude`. E.g.,
111111

connectors/messaging/kinesis/yaml.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ This is a sample config for Kinesis:
8080
<ContentSection id={1} title="Source Configuration" lines="1-3">
8181
Configure the source type and service name.
8282
</ContentSection>
83-
<ContentSection id={2} title="AWS Configuration" lines="7">
83+
<ContentSection id={2} title="AWS Configuration" lines="7-16">
8484
Configure AWS credentials and settings for accessing Kinesis streams.
8585
</ContentSection>
8686
</ContentPanel>

connectors/ml-model/vertexai/yaml.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,14 @@ This is a sample config for VertexAI:
4747

4848
<CodePreview>
4949
<ContentPanel>
50-
<ContentSection id={1} title="credentials" lines="6-7">
50+
<ContentSection id={1} title="credentials" lines="6-20">
5151
**credentials**:
5252
You can authenticate with your vertexai instance using either `GCP Credentials Path` where you can specify the file path of the service account key or you can pass the values directly by choosing the `GCP Credentials Values` from the service account key file.
5353
You can checkout [this](https://cloud.google.com/iam/docs/keys-create-delete#iam-service-account-keys-create-console) documentation on how to create the service account keys and download it.
5454
**gcpConfig:**
5555
**1.** Passing the raw credential values provided by VertexAI. This requires us to provide the following information, all provided by VertexAI:
5656
</ContentSection>
57-
<ContentSection id={2} title="location" lines="8">
57+
<ContentSection id={2} title="location" lines="21">
5858
**2.** Passing a local file path that contains the credentials:
5959
- **gcpCredentialsPath**
6060
**Location**:

0 commit comments

Comments
 (0)