Enhance documentation #230

sanjushahgupta · 2024-11-19T11:18:38Z

No description provided.

karakanb · 2024-11-19T15:48:55Z

docs/ingestion/airtable.md

+- name: The name of the asset.
+
+- type: Specifies the type of the asset. Set this to ingestr to use the ingestr data pipeline.
+
+- connection: This is the destination connection, which defines where the data should be stored. For example: "postgres" indicates that the ingested data will be stored in a PostgreSQL database.
+
+**parameters:**
+- source_connection: The name of the airtable connection defined in .bruin.yml.
+
+- source_table: The name of the data table in airtable that you want to ingest. For example, "Details" is the table of airtable that you want to ingest.


I'd remove the extra spacing and put things within quotes:

Suggested change

- name: The name of the asset.

- type: Specifies the type of the asset. Set this to ingestr to use the ingestr data pipeline.

- connection: This is the destination connection, which defines where the data should be stored. For example: "postgres" indicates that the ingested data will be stored in a PostgreSQL database.

**parameters:**

- source_connection: The name of the airtable connection defined in .bruin.yml.

- source_table: The name of the data table in airtable that you want to ingest. For example, "Details" is the table of airtable that you want to ingest.

**Parameters:**

- `name`: The name of the asset.

- `type`: Specifies the type of the asset. Set this to ingestr to use the ingestr data pipeline.

- `connection`: This is the destination connection, which defines where the data should be stored. For example: `postgres` indicates that the ingested data will be stored in a PostgreSQL database.

- `source_connection`: The name of the Airtable connection defined in .bruin.yml.

- `source_table`: The name of the data table in Airtable that you want to ingest. For example, `details` is the table of airtable that you want to ingest.

Careful with the syntax and casing.

karakanb · 2024-11-19T15:49:19Z

docs/ingestion/airtable.md

+
+- source_table: The name of the data table in airtable that you want to ingest. For example, "Details" is the table of airtable that you want to ingest.
+
+**Step 3: [Run](https://bruin-data.github.io/bruin/commands/run.html) Asset to Ingest Data**


You should make these links relative:

Suggested change

**Step 3: [Run](https://bruin-data.github.io/bruin/commands/run.html) Asset to Ingest Data**

**Step 3: [Run](/commands/run.html) Asset to Ingest Data**

karakanb · 2024-11-19T15:49:38Z

docs/ingestion/airtable.md

+
+**Step 3: [Run](https://bruin-data.github.io/bruin/commands/run.html) Asset to Ingest Data**
+```
+bruin run --file airtable_ingestion.yml


there's no --file flag, you just give the right path:

Suggested change

bruin run --file airtable_ingestion.yml

bruin run assets/airtable_ingestion.yml

karakanb · 2024-11-19T15:50:01Z

docs/ingestion/airtable.md

+```
+bruin run --file airtable_ingestion.yml
+```
+It will ingest airtable data to postgres. 


Suggested change

It will ingest airtable data to postgres.

As a result of this command, Bruin will ingest data from the given Airtable table into your Postgres database.

karakanb · 2024-11-19T15:50:40Z

docs/ingestion/facebook-ads.md

@@ -2,13 +2,13 @@
 Facebook Ads is the advertising platform that helps users to create targeted ads on Facebook, Instagram and Messenger.
 ingestr supports Facebook-Ads as a source for [ingestr assets](https://bruin-data.github.io/bruin/assets/ingestr.html), allowing you to ingest data from Facebook-Ads into your data warehouse.

-In order to have set up Facebook-Ads connection, you need to add a configuration item to `connections` in the `.bruin.yml` file complying with the following schema. For more information on how to get these credentials, read [here](https://bruin-data.github.io/ingestr/supported-sources/facebook-ads.html)
+In order to have set up Facebook-Ads connection, you need to add a configuration item in the `.bruin.yml` and `asset` file. You will also need `access token` and `accound id`. For more information on how to get these credentials, read [here](https://dlthub.com/docs/dlt-ecosystem/verified-sources/facebook_ads#setup-guide)


Please give the variable names as they should be written:

Suggested change

In order to have set up Facebook-Ads connection, you need to add a configuration item in the `.bruin.yml` and `asset` file. You will also need `access token` and `accound id`. For more information on how to get these credentials, read [here](https://dlthub.com/docs/dlt-ecosystem/verified-sources/facebook_ads#setup-guide)

In order to have set up Facebook-Ads connection, you need to add a configuration item in the `.bruin.yml` and `asset` file. You will also need `access_token` and `account_id`. For more information on how to get these credentials, please take a look at [here](https://dlthub.com/docs/dlt-ecosystem/verified-sources/facebook_ads#setup-guide).

karakanb · 2024-11-19T15:50:53Z

docs/ingestion/facebook-ads.md

 **Step 2: Create an Asset File for Data Ingestion**

-To ingest data from Facebook Ads, you need to create an [asset configuration file](https://bruin-data.github.io/bruin/assets/ingestr.html#template). This file defines the data flow from the source to the destination. Create a YAML file (e.g., facebook_ads_ingestion.yml) and add the following content:
+To ingest data from Facebook Ads, you need to create an [asset configuration](https://bruin-data.github.io/bruin/assets/ingestr.html#asset-structure) file. This file defines the data flow from the source to the destination. Create a YAML file (e.g., facebook_ads_ingestion.yml) and add the following content:


please make the links relative

karakanb · 2024-11-19T15:51:05Z

docs/ingestion/hubspot.md

+
+Follow the steps below to correctly set up HubSpot as a data source and run ingestion.
+
+**Step 1: Add a Connection to .bruin.yml**


let's use sentence case in the titles

Suggested change

**Step 1: Add a Connection to .bruin.yml**

**Step 1: Add a connection to `.bruin.yml`**

karakanb · 2024-11-19T15:51:39Z

docs/ingestion/hubspot.md

same as the airtable parameters

karakanb · 2024-11-19T15:51:50Z

docs/ingestion/s3.md

+
+- type: Specifies the type of the asset. Set this to ingestr to use the ingestr data pipeline.
+
+- connection: This is the destination connection, which defines where the data should be stored. For example: "postgres" indicates that the ingested data will be stored in a PostgreSQL database.
+
+**parameters:**
+- source_connection: The name of the S3 connection defined in .bruin.yml.
+
+- source_table: The name of the file or folder in S3 that you want to ingest. For example, 'students_details' would ingest data related to student details. 
+
+**Step 3: [Run](https://bruin-data.github.io/bruin/commands/run.html) Asset to Ingest Data**
+```
+bruin run --file s3_ingestion.yml
+```
+It will ingest S3 data to postgres.


same as the airtable

sanjushahgupta added 3 commits November 19, 2024 11:45

enhance airtable docs

4a976d1

small changes

3d2bf91

small changes

25ab2f9

sanjushahgupta requested a review from karakanb November 19, 2024 12:46

sanjushahgupta added 4 commits November 19, 2024 13:54

enhance hubspot doc

46a50da

update docs - hubspot, airtabale, s3

b420003

change links

e1b5d28

update docs

50730de

karakanb reviewed Nov 19, 2024

View reviewed changes

sanjushahgupta and others added 16 commits November 19, 2024 16:54

update chess doc

c15e186

update airtable doc

cdbe83b

airtable: correct link

69eaad7

add screenshot

e15a417

change step to header

b30ed1b

update hubspot

443fc23

add hubspot example

5654dae

update s3 doc

5221850

S3: add ingestion example and small changes

bb3da67

small changes

4b751ef

change absolute to relative path

62b3c9a

airtable: change image

ebc6f42

update facebook-ads docs

014f14b

facebookads: add dest table image

6d5d213

chess: update doc

30f724b

chess: add image

6d44e58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhance documentation #230

Enhance documentation #230

sanjushahgupta commented Nov 19, 2024

karakanb Nov 19, 2024

karakanb Nov 19, 2024

karakanb Nov 19, 2024

karakanb Nov 19, 2024

karakanb Nov 19, 2024

karakanb Nov 19, 2024

karakanb Nov 19, 2024

karakanb Nov 19, 2024

karakanb Nov 19, 2024


		- source_table: The name of the data table in airtable that you want to ingest. For example, "Details" is the table of airtable that you want to ingest.

		Step 3: [Run](https://bruin-data.github.io/bruin/commands/run.html) Asset to Ingest Data

	Step 3: [Run](https://bruin-data.github.io/bruin/commands/run.html) Asset to Ingest Data
	Step 3: [Run](/commands/run.html) Asset to Ingest Data

	bruin run --file airtable_ingestion.yml
	bruin run assets/airtable_ingestion.yml

	It will ingest airtable data to postgres.
	As a result of this command, Bruin will ingest data from the given Airtable table into your Postgres database.

	In order to have set up Facebook-Ads connection, you need to add a configuration item in the `.bruin.yml` and `asset` file. You will also need `access token` and `accound id`. For more information on how to get these credentials, read [here](https://dlthub.com/docs/dlt-ecosystem/verified-sources/facebook_ads#setup-guide)
	In order to have set up Facebook-Ads connection, you need to add a configuration item in the `.bruin.yml` and `asset` file. You will also need `access_token` and `account_id`. For more information on how to get these credentials, please take a look at [here](https://dlthub.com/docs/dlt-ecosystem/verified-sources/facebook_ads#setup-guide).


		Follow the steps below to correctly set up HubSpot as a data source and run ingestion.

		Step 1: Add a Connection to .bruin.yml

	Step 1: Add a Connection to .bruin.yml
	Step 1: Add a connection to `.bruin.yml`

Enhance documentation #230

Are you sure you want to change the base?

Enhance documentation #230

Conversation

sanjushahgupta commented Nov 19, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment