Skip to content

Commit d1fe55b

Browse files
RounakDhillon“Rounak
andauthored
Docs: YAML file Correction (#72)
Co-authored-by: “Rounak <“rounakpreet.d@deuexsolutions.com”>
1 parent 2f8eec8 commit d1fe55b

File tree

92 files changed

+576
-591
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+576
-591
lines changed

connectors/dashboard/domo-dashboard/yaml.mdx

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

6161
</ContentSection>
6262

63-
<ContentSection id={2} title="Client ID" lines="6">
63+
<ContentSection id={2} title="Client ID" lines="7">
6464

6565
**clientId**: Client ID to Connect to DOMO Dashboard.
6666

6767
</ContentSection>
6868

69-
<ContentSection id={3} title="Secret Token" lines="7">
69+
<ContentSection id={3} title="Secret Token" lines="8">
7070

7171
**secretToken**: Secret Token to Connect DOMO Dashboard.
7272

7373
</ContentSection>
7474

75-
<ContentSection id={4} title="Access Token" lines="8">
75+
<ContentSection id={4} title="Access Token" lines="9">
7676

7777
**accessToken**: Access to Connect to DOMO Dashboard.
7878

7979
</ContentSection>
8080

81-
<ContentSection id={5} title="API Host" lines="9">
81+
<ContentSection id={5} title="API Host" lines="10">
8282

8383
**apiHost**: API Host to Connect to DOMO Dashboard instance.
8484

8585
</ContentSection>
8686

87-
<ContentSection id={6} title="Instance Domain" lines="10">
87+
<ContentSection id={6} title="Instance Domain" lines="11">
8888

8989
**instanceDomain**: URL to connect to your Domo instance UI. For example `https://<your>.domo.com`.
9090

connectors/dashboard/grafana/yaml.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,37 +55,37 @@ Configure the source type and service name for your Grafana connector.
5555

5656
</ContentSection>
5757

58-
<ContentSection id={2} title="Host Port" lines="6">
58+
<ContentSection id={2} title="Host Port" lines="7">
5959

6060
**hostPort**: URL or IP address of your Grafana instance.
6161

6262
</ContentSection>
6363

64-
<ContentSection id={3} title="API Key" lines="7">
64+
<ContentSection id={3} title="API Key" lines="8">
6565

6666
**apiKey**: Service Account Token for authentication (format: `glsa_xxxxx`). Admin role recommended.
6767

6868
</ContentSection>
6969

70-
<ContentSection id={4} title="Verify SSL" lines="8">
70+
<ContentSection id={4} title="Verify SSL" lines="9">
7171

7272
**verifySSL**: (Optional) Whether to verify SSL certificates. Default: true
7373

7474
</ContentSection>
7575

76-
<ContentSection id={5} title="Include Tags" lines="12">
76+
<ContentSection id={5} title="Include Tags" lines="13">
7777

7878
**includeTags**: When set to true, imports Grafana tags as OpenMetadata tags.
7979

8080
</ContentSection>
8181

82-
<ContentSection id={6} title="Lineage Information" lines="13-14">
82+
<ContentSection id={6} title="Lineage Information" lines="14">
8383

8484
Configure database service prefixes for lineage extraction.
8585

8686
</ContentSection>
8787

88-
<ContentSection id={7} title="Sink Configuration" lines="15-17">
88+
<ContentSection id={7} title="Sink Configuration" lines="16-18">
8989

9090
To send the metadata to OpenMetadata, specify `type: metadata-rest`.
9191

connectors/dashboard/lightdash/yaml.mdx

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

6060
</ContentSection>
6161

62-
<ContentSection id={2} title="Host and Port" lines="6">
62+
<ContentSection id={2} title="Host and Port" lines="3">
6363

6464
**Host and Port**: Specify the network location where your Lightdash instance is accessible, combining both hostname and port in a URI format: either `http://hostname:port` or `https://hostname:port`, based on your security needs.
6565
**Example**: For a local setup, use `http://localhost:8080`; for a server deployment, it might be `https://lightdash.example.com:3000`.
6666
Ensure the specified port is open and accessible through network firewall settings.
6767

6868
</ContentSection>
6969

70-
<ContentSection id={3} title="API Key" lines="7">
70+
<ContentSection id={3} title="API Key" lines="8">
7171

7272
**API Key**: This key authenticates requests to your Lightdash instance. Keep the API Key secure, sharing it only with authorized applications or users.
7373

7474
</ContentSection>
7575

76-
<ContentSection id={4} title="Project UUID" lines="8">
76+
<ContentSection id={4} title="Project UUID" lines="9">
7777

7878
**Project UUID**: This unique identifier links API requests or configurations to a specific project in Lightdash.
7979

8080
</ContentSection>
8181

82-
<ContentSection id={5} title="Space UUID" lines="9">
82+
<ContentSection id={5} title="Space UUID" lines="10">
8383

8484
**Space UUID**: Identifies a specific "Space" in Lightdash, used to organize dashboards, charts, and assets.
8585

8686
</ContentSection>
8787

88-
<ContentSection id={6} title="Proxy Authentication" lines="10">
88+
<ContentSection id={6} title="Proxy Authentication" lines="11">
8989

9090
**Proxy Authentication**: If your Lightdash instance requires authentication through a proxy server, provide proxy credentials. Proxy authentication controls access to external resources and Lightdash.
9191

connectors/dashboard/looker/yaml.mdx

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

7676
</ContentSection>
7777

78-
<ContentSection id={2} title="Client ID" lines="6">
78+
<ContentSection id={2} title="Client ID" lines="7">
7979

8080
**clientId**: Specify the Client ID to connect to Looker. It should have enough privileges to read all the metadata.
8181

8282
</ContentSection>
8383

84-
<ContentSection id={3} title="Client Secret" lines="7">
84+
<ContentSection id={3} title="Client Secret" lines="8">
8585

8686
**clientSecret**: Client Secret to connect to Looker.
8787

8888
</ContentSection>
8989

90-
<ContentSection id={4} title="Host Port" lines="8">
90+
<ContentSection id={4} title="Host Port" lines="9">
9191

9292
**hostPort**: URL to the Looker instance.
9393

9494
</ContentSection>
9595

96-
<ContentSection id={5} title="GitHub Credentials" lines="9-13">
96+
<ContentSection id={5} title="GitHub Credentials" lines="12-14">
9797

9898
**githubCredentials** (Optional): GitHub API credentials to extract LookML Views' information by parsing the source `.lkml` files. There are three
9999
properties we need to add in this case:

connectors/dashboard/metabase/yaml.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,19 +59,19 @@ Configure the source type and service name for your Metabase connector.
5959

6060
</ContentSection>
6161

62-
<ContentSection id={2} title="Username" lines="6">
62+
<ContentSection id={2} title="Username" lines="7">
6363

6464
**username**: Username to connect to Metabase, for ex. `user@organization.com`. This user should have access to relevant dashboards and charts in Metabase to fetch the metadata.
6565

6666
</ContentSection>
6767

68-
<ContentSection id={3} title="Password" lines="7">
68+
<ContentSection id={3} title="Password" lines="8">
6969

7070
**password**: Password of the user account to connect with Metabase.
7171

7272
</ContentSection>
7373

74-
<ContentSection id={4} title="Host Port" lines="8">
74+
<ContentSection id={4} title="Host Port" lines="9">
7575

7676
**hostPort**: The hostPort parameter specifies the host and port of the Metabase instance. This should be specified as a string in the format `http://hostname:port` or `https://hostname:port`. For example, you might set the hostPort parameter to `https://org.metabase.com:3000`.
7777

connectors/dashboard/microstrategy/yaml.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,20 +52,20 @@ This is a sample config for MicroStrategy:
5252
<ContentSection id={1} title="Source Configuration" lines="1-3">
5353
Configure the source type and service name.
5454
</ContentSection>
55-
<ContentSection id={2} title="Username" lines="6">
55+
<ContentSection id={2} title="Username" lines="7">
5656
- **Username**: Username to connect to MicroStrategy, e.g., user@organization.com. This user should have access to relevant dashboards and charts in MicroStrategy to fetch the metadata.
5757
</ContentSection>
58-
<ContentSection id={3} title="Password" lines="7">
58+
<ContentSection id={3} title="Password" lines="8">
5959
- **Password**: Password of the user account to connect with MicroStrategy.
6060
</ContentSection>
61-
<ContentSection id={4} title="Host Port" lines="8">
61+
<ContentSection id={4} title="Host Port" lines="9">
6262
- **Host Port**: This parameter specifies the host of the MicroStrategy instance. This should be specified as a URI string in the format http://hostname or https://hostname.
6363
For example, you might set it to https://demo.microstrategy.com.
6464
</ContentSection>
65-
<ContentSection id={5} title="Project Name" lines="9">
65+
<ContentSection id={5} title="Project Name" lines="10">
6666
- **Project Name**: The name of the project within MicroStrategy that OpenMetadata will connect to, linking to the relevant dashboards and reports for metadata retrieval.
6767
</ContentSection>
68-
<ContentSection id={6} title="Login Mode" lines="10">
68+
<ContentSection id={6} title="Login Mode" lines="11">
6969
- **Login Mode**: Login Mode for Microstrategy's REST API connection. You can authenticate with one of the following authentication modes: `Standard (1)`, `Anonymous (8)`. Default will be `Standard (1)`.
7070
If you're using demo account for Microstrategy, it will be needed to authenticate through loginMode `8`.
7171
</ContentSection>

connectors/dashboard/mode/yaml.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@ This is a sample config for Mode:
5252
<ContentSection id={1} title="Source Configuration" lines="1-3">
5353
Configure the source type and service name.
5454
</ContentSection>
55-
<ContentSection id={2} title="hostPort" lines="5">
55+
<ContentSection id={2} title="hostPort" lines="7">
5656
**hostPort**: Host and Port Mode Dashboard.
5757
The hostPort parameter specifies the host and port of the Mode server. This should be specified as a string in the format `https://app.mode.com`.
5858
</ContentSection>
59-
<ContentSection id={3} title="accessToken" lines="6">
59+
<ContentSection id={3} title="accessToken" lines="8">
6060
**accessToken**: Access Token for Mode Dashboard.
6161
Get the Access Token by following below mentioned steps:
6262
- Navigate to your Mode homepage.
@@ -66,16 +66,16 @@ Get the Access Token by following below mentioned steps:
6666
- Copy the generated access token and password.
6767
For detailed information visit [here](https://mode.com/developer/api-reference/introduction/).
6868
</ContentSection>
69-
<ContentSection id={4} title="accessTokenPassword" lines="7">
69+
<ContentSection id={4} title="accessTokenPassword" lines="9">
7070
**accessTokenPassword**: Access Token Password for Mode Dashboard.
7171
Copy the access token password from the step above where a new token is generated.
7272
For detailed information visit [here](https://mode.com/developer/api-reference/introduction/).
7373
</ContentSection>
74-
<ContentSection id={5} title="workspaceName" lines="8">
74+
<ContentSection id={5} title="workspaceName" lines="10">
7575
**workspaceName**: Mode Workspace Name.
7676
Name of the mode workspace from where the metadata is to be fetched.
7777
</ContentSection>
78-
<ContentSection id={6} title="filterQueryParam" lines="9">
78+
<ContentSection id={6} title="filterQueryParam" lines="11">
7979
**filterQueryParam**: Filter query parameter for some of the Mode API calls.
8080
</ContentSection>
8181
</ContentPanel>

connectors/dashboard/powerbi-report-server/yaml.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,20 +52,20 @@ This is a sample config for Metabase:
5252
<ContentSection id={1} title="Source Configuration" lines="1-3">
5353
Configure the source type and service name.
5454
</ContentSection>
55-
<ContentSection id={2} title="hostPort" lines="6">
55+
<ContentSection id={2} title="hostPort" lines="7">
5656
**hostPort**:
5757
This parameter specifies the host and port of the Metabase instance. This should be specified as a URI string in the format `http://hostname:port` or `https://hostname:port`.
58-
For example, you might set it to `http://192.168.1.1:80`.
58+
For example, you might set it to `http://192.178.1.1:80`.
5959
</ContentSection>
60-
<ContentSection id={3} title="username" lines="7">
60+
<ContentSection id={3} title="username" lines="8">
6161
**username**:
6262
Username to connect to PowerBI Report Server.
6363
</ContentSection>
64-
<ContentSection id={4} title="password" lines="8">
64+
<ContentSection id={4} title="password" lines="9">
6565
**password**:
6666
Password to connect to PowerBI Report Server.
6767
</ContentSection>
68-
<ContentSection id={5} title="webPortalVirtualDirectory" lines="9">
68+
<ContentSection id={5} title="webPortalVirtualDirectory" lines="10">
6969
**webPortalVirtualDirectory**
7070
Web Portal Virtual Directory name which you have configured in your PowerBI Report Server configuration manager.
7171
</ContentSection>

connectors/dashboard/powerbi/yaml.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -101,15 +101,15 @@ This is a sample config for PowerBI:
101101
<ContentSection id={1} title="Source Configuration" lines="1-3">
102102
Configure the source type and service name.
103103
</ContentSection>
104-
<ContentSection id={2} title="clientId" lines="6">
104+
<ContentSection id={2} title="clientId" lines="7">
105105
**clientId**: PowerBI Client ID.
106106
To get the client ID (also know as application ID), follow these steps:
107107
- Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
108108
- Search for App registrations and select the App registrations link.
109109
- Select the Azure AD app you're using for embedding your Power BI content.
110110
- From the Overview section, copy the Application (client) ID.
111111
</ContentSection>
112-
<ContentSection id={3} title="clientSecret" lines="7">
112+
<ContentSection id={3} title="clientSecret" lines="8">
113113
**clientSecret**: PowerBI Client Secret.
114114
To get the client secret, follow these steps:
115115
- Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
@@ -120,43 +120,43 @@ To get the client secret, follow these steps:
120120
- In the Add a client secret pop-up window, provide a description for your application secret, select when the application secret expires, and select Add.
121121
- From the Client secrets section, copy the string in the Value column of the newly created application secret.
122122
</ContentSection>
123-
<ContentSection id={4} title="tenantId" lines="8">
123+
<ContentSection id={4} title="tenantId" lines="9">
124124
**tenantId**: PowerBI Tenant ID.
125125
To get the tenant ID, follow these steps:
126126
- Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
127127
- Search for App registrations and select the App registrations link.
128128
- Select the Azure AD app you're using for Power BI.
129129
- From the Overview section, copy the Directory (tenant) ID.
130130
</ContentSection>
131-
<ContentSection id={5} title="scope" lines="9-10">
131+
<ContentSection id={5} title="scope" lines="10">
132132
**scope**: Service scope.
133133
To let OM use the Power BI APIs using your Azure AD app, you'll need to add the following scopes:
134134
- https://analysis.windows.net/powerbi/api/.default
135135
Instructions for adding these scopes to your app can be found by following this link: https://analysis.windows.net/powerbi/api/.default.
136136
</ContentSection>
137-
<ContentSection id={6} title="authorityUri" lines="11">
137+
<ContentSection id={6} title="authorityUri" lines="12">
138138
**authorityUri**: Authority URI for the service.
139139
To identify a token authority, you can provide a URL that points to the authority in question.
140140
If you don't specify a URL for the token authority, we'll use the default value of https://login.microsoftonline.com/.
141141
</ContentSection>
142-
<ContentSection id={7} title="hostPort" lines="12">
142+
<ContentSection id={7} title="hostPort" lines="13">
143143
**hostPort**: URL to the PowerBI instance.
144144
To connect with your Power BI instance, you'll need to provide the host URL. If you're using an on-premise installation of Power BI, this will be the domain name associated with your instance.
145145
If you don't specify a host URL, we'll use the default value of https://app.powerbi.com to connect with your Power BI instance.
146146
</ContentSection>
147-
<ContentSection id={8} title="Pagination Entity Per Page" lines="13">
147+
<ContentSection id={8} title="Pagination Entity Per Page" lines="14">
148148
**Pagination Entity Per Page**:
149149
The pagination limit for Power BI APIs can be set using this parameter. The limit determines the number of records to be displayed per page.
150150
By default, the pagination limit is set to 100 records, which is also the maximum value allowed.
151151
</ContentSection>
152-
<ContentSection id={9} title="Use Admin APIs" lines="14">
152+
<ContentSection id={9} title="Use Admin APIs" lines="15">
153153
**Use Admin APIs**:
154154
Option for using the PowerBI admin APIs:
155155
Refer to the section [here](/connectors/dashboard/powerbi#powerbi-admin-and-nonadmin-apis) to get more information.
156156
- Enabled (Use PowerBI Admin APIs)
157157
- Disabled (Use Non-Admin PowerBI APIs)
158158
</ContentSection>
159-
<ContentSection id={10} title="pbitFilesSource" lines="15-30">
159+
<ContentSection id={10} title="pbitFilesSource" lines="18-20">
160160
**pbitFilesSource**: Source to get the .pbit files to extract lineage information. Select one of local, azureConfig, gcsConfig, s3Config.
161161
- `pbitFileConfigType`: Determines the storage backend type (azure, gcs, or s3).
162162
- `securityConfig`: Authentication credentials for accessing the storage backend.

connectors/dashboard/qlikcloud/yaml.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Configure the source type and service name.
5656

5757
</ContentSection>
5858

59-
<ContentSection id={2} title="token" lines="6-7">
59+
<ContentSection id={2} title="token" lines="7">
6060

6161
**token**: Qlik Cloud API Access Token
6262

0 commit comments

Comments
 (0)