Skip to content

Commit 3de14b4

Browse files
authored
Merge pull request #8007 from carlota-moh/develop
chore: small fixes for serialization of batch 2.2 + batch 6.2
2 parents c9e5cf1 + 7756430 commit 3de14b4

File tree

29 files changed

+68
-87
lines changed

29 files changed

+68
-87
lines changed

src/connections/destinations/add-destination.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ You can also add a destination directly from the source's settings page in the S
5252

5353
#### Adding a destination using the Public API
5454

55-
You can use the Segment Public API to add destinations to your workspace using the [Create Destination endpoint](https://docs.segmentapis.com/tag/Destinations#operation/createDestination){:target = "_blank"}. The API requires an authorization token, and uses the `name` field as a namespace that defines which _source_ the destination is connected to. You send the rest of the destination's configuration as a JSON blob. View the documentation page in the Segment Catalog, or query the [Segment Catalog API](https://docs.segmentapis.com/tag/Catalog){:target="_blank"}, for a destination to see the available settings.
55+
You can use the Segment Public API to add destinations to your workspace using the [Create Destination endpoint](https://docs.segmentapis.com/tag/Destinations#operation/createDestination){:target="_blank"}. The API requires an authorization token, and uses the `name` field as a namespace that defines which _source_ the destination is connected to. You send the rest of the destination's configuration as a JSON blob. View the documentation page in the Segment Catalog, or query the [Segment Catalog API](https://docs.segmentapis.com/tag/Catalog){:target="_blank"}, for a destination to see the available settings.
5656

5757
> success ""
5858
> You must use an authorization token to access the Public API, and these tokens are tied to specific workspaces. If you use the Public API to access multiple workspaces, make sure you're using the token for the workspace you want to access before proceeding.
@@ -112,7 +112,7 @@ Multi-instance support is not available for most hybrid Actions destinations or
112112

113113
Segment does not support connecting a single source to multiple instances of a [Data Lakes](/docs/connections/storage/data-lakes/) destination.
114114

115-
> warning "Non-mobile sources can only connect to _one_ device-mode instance of a destination"
115+
> warning "Non-mobile sources can only connect to one device-mode instance of a destination"
116116
> You cannot connect a source to more than one instance of a destination that operates only in device-mode. For more information about device-mode restrictions, see the [Sending Segment data to Destinations](/docs/connections/destinations/add-destination/#connecting-one-source-to-multiple-instances-of-a-destination:~:text=Multi%2Dinstance%20destinations-,and,-Device%2Dmode) documentation.
117117
118118
> success ""

src/connections/destinations/destination-filters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Common use cases for destination filters include:
1818
- Increasing data relevance in your destinations by removing unused or unwanted data
1919
- Preventing test or internally-generated events from reaching your production tools
2020

21-
### Limitations
21+
## Limitations
2222

2323
Keep the following limitations in mind when you use destination filters:
2424

src/connections/functions/aws-apis.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ The [`aws-sdk`](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guid
88
To set up your functions to call AWS APIs:
99
1. Create an IAM role in your AWS account that your function will assume before making AWS API calls.
1010
1. Make sure you have these two values:
11-
* **Principal account ID**: This is the ID number for the AWS account that your function runs in. For destination functions, this is `458175278816` and for source functions this is `300240842537`.
12-
* **External ID**: This is the value your IAM role uses to ensure that only your functions have the ability to assume the role. Segment recommends you to choose a long string of at least 32 random characters and treat it as if it were an API key or a password.
11+
* **Principal account ID**: This is the ID number for the AWS account that your function runs in. For destination functions, this is `458175278816` and for source functions this is `300240842537`.
12+
* **External ID**: This is the value your IAM role uses to ensure that only your functions have the ability to assume the role. Segment recommends you to choose a long string of at least 32 random characters and treat it as if it were an API key or a password.
1313
2. Create an IAM role in your AWS account with the [minimum set of necessary permissions](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege){:target="_blank"}.
1414
3. Add a trust relationship to your role with the following policy, filling in the principal account ID and external ID from step 1.1:
1515
```json
@@ -33,11 +33,13 @@ To set up your functions to call AWS APIs:
3333
```
3434

3535
2. Create your function.
36-
<br> Now that you have an IAM role in your AWS account, you can create your source or destination function. Segment recommends you to use function settings to make the IAM role configurable. This allows you to use different roles for different instances of your function and to securely store your external ID value by making it a "sensitive" setting. Here are the required settings:
37-
* **IAM Role ARN**: A string setting that is the ARN for the IAM role above. For example, `arn:aws:iam::1234567890:role/my-secure-role`.
38-
* **IAM Role External ID**: A sensitive string setting that is the external ID for your IAM role.
3936

40-
Below is an example destination function that uploads each event received to an S3 bucket (configured using additional "S3 Bucket" and "S3 Bucket Region" settings). It uses the built-in local cache to retain S3 clients between requests to minimize processing time and to allow different instances of the function to use different IAM roles.
37+
Now that you have an IAM role in your AWS account, you can create your source or destination function. Segment recommends you to use function settings to make the IAM role configurable. This allows you to use different roles for different instances of your function and to securely store your external ID value by making it a "sensitive" setting. Here are the required settings:
38+
39+
* **IAM Role ARN**: A string setting that is the ARN for the IAM role above. For example, `arn:aws:iam::1234567890:role/my-secure-role`.
40+
* **IAM Role External ID**: A sensitive string setting that is the external ID for your IAM role.
41+
42+
Below is an example destination function that uploads each event received to an S3 bucket (configured using additional "S3 Bucket" and "S3 Bucket Region" settings). It uses the built-in local cache to retain S3 clients between requests to minimize processing time and to allow different instances of the function to use different IAM roles.
4143

4244
```javascript
4345
async function getS3(settings) {

src/connections/reverse-etl/reverse-etl-source-setup-guides/db2-setup.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,11 @@ To set up Db2 as your Reverse ETL source:
6161
4. Click **+ Add Reverse ETL source**.
6262
5. Select **Db2** and click **Add Source**.
6363
6. Fill in the following Db2 connection settings:
64-
* Hostname: `<hostname>`
65-
* Port: `<port>`
66-
* Database: `<db_name>`
67-
* Username: `<segment_db2_user>`
68-
* Password: `<password>`
64+
* Hostname: `<hostname>`
65+
* Port: `<port>`
66+
* Database: `<db_name>`
67+
* Username: `<segment_db2_user>`
68+
* Password: `<password>`
6969
7. Click **Test Connection** to validate the setup.
7070
8. If the connection is successful, click **Add source**.
7171

src/connections/reverse-etl/setup.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ To add your warehouse as a source:
2525
2. Click **+ Add Reverse ETL source**.
2626
3. Select the source you want to add.
2727
4. Follow the corresponding guide to set up the required permissions for your Reverse ETL source:
28-
- [Azure Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/azure-setup)
29-
- [BigQuery Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/bigquery-setup)
30-
- [Databricks Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/databricks-setup)
31-
- [Db2 Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/db2-setup)
32-
- [Postgres Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/postgres-setup)
33-
- [Redshift Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/redshift-setup)
34-
- [Snowflake Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/snowflake-setup)
28+
- [Azure Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/azure-setup)
29+
- [BigQuery Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/bigquery-setup)
30+
- [Databricks Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/databricks-setup)
31+
- [Db2 Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/db2-setup)
32+
- [Postgres Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/postgres-setup)
33+
- [Redshift Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/redshift-setup)
34+
- [Snowflake Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/snowflake-setup)
3535

3636
## Step 2: Add a model
3737
Models define sets of data you want to sync to your Reverse ETL destinations. A source can have multiple models. Segment supports [SQL models](/docs/connections/reverse-etl/setup/#step-4-create-mappings) and [dbt models](/docs/segment-app/extensions/dbt/).

src/connections/reverse-etl/system.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The records table helps in determining new and updated rows by comparing the che
3131

3232
### Checkpoint table
3333

34-
The `checkpoints_<subscription_id>` tables are located within the __segment_reverse_etl schema.
34+
The `checkpoints_<subscription_id>` tables are located within the `__segment_reverse_etl` schema.
3535

3636
This table contains the following columns:
3737

src/connections/sources/about-cloud-sources.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ Cloud-App Sources (often shortened to Cloud Sources) allow you to pull in data f
99

1010
As in the basic tracking API, _objects_ usually contain information about a person or group which is updated over time, while _event_ data happens once, and is appended to a list.
1111

12-
### Event Cloud-App Sources
12+
## Event Cloud-App Sources
1313

1414
Event Cloud Sources can export their data both into Segment warehouses, and into other enabled Segment integrations that work with event data.
1515

16-
### Object Cloud-App Sources
16+
## Object Cloud-App Sources
1717

1818
Object Cloud App Sources can export data and import it directly into a Segment warehouse. You *must* have a Segment warehouse enabled before you enable these. From the warehouse, you can analyze your data with SQL, use [Reverse ETL](/docs/connections/reverse-etl) to extract data, or use Engage SQL Traits to build audiences. Some examples of Object Cloud sources are Salesforce (account information), Zendesk (support cases), and Stripe (payments information).
1919

src/connections/sources/catalog/cloud-apps/bluedot/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ This source is maintained by Bluedot. For any issues with the source, [contact B
1616
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank"} click **Add Source**.
1717
2. Search for **Bluedot** in the Sources Catalog, select **Bluedot**, and click **Add Source**.
1818
3. On the next screen, give the Source a name configure any other settings.
19-
2019
The name identifies this source within your workspace, and typically reflects the name of the application. The name can be anything, but Segment recommends that you use something that reflects the source itself and distinguishes amongst your environments (for example, `SourceName_Prod`, `SourceName_Staging`, or `SourceName_Dev`).
2120
4. Click **Add Source** to save your settings.
2221
5. Copy the Write key from the Segment UI and log in to Bluedot Canvas - navigate to Integrations > Select the Project you want link > Segment Integration and paste the key to connect.

src/connections/sources/catalog/cloud-apps/clevertap/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) which can ex
1414
This source is maintained by CleverTap. For any issues with the source, [contact their Support team](https://help.clevertap.com/hc/en-us/requests/new){:target="_blank”}.
1515

1616
> info "This is a Beta source"
17-
> The CleverTap Source is in beta, which means that they are still actively developing the source. If you're interested in joining their beta program or have any feedback to help improve the CleverTap Source and its documentation, [let their team know](https://help.clevertap.com/hc/en-us/requests/new){:target="_blank"}._
17+
> The CleverTap Source is in beta, which means that they are still actively developing the source. If you're interested in joining their beta program or have any feedback to help improve the CleverTap Source and its documentation, [let their team know](https://help.clevertap.com/hc/en-us/requests/new){:target="_blank"}.
1818
1919
## Getting Started
2020

@@ -33,8 +33,8 @@ This source is maintained by CleverTap. For any issues with the source, [contact
3333

3434
The table below lists events that CleverTap sends to Segment. These events appear as tables in your warehouse and as regular events in other Destinations.
3535

36-
| Name | Description
37-
| --------------- | ----------- | ------------------------- |
36+
| Name | Description |
37+
| --------------- | ----------- |
3838
| App Launched | This event is captured every time a user launches the application. |
3939
| App Installed | The event is captured when the user launches the app for the first time. |
4040
| App Uninstalled | This event is captured when a user uninstalls your application. |

src/connections/sources/catalog/libraries/mobile/android/quickstart.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,8 +137,6 @@ To get started, we recommend tracking just a few important events. You can alway
137137

138138
Once you've added a few `track` calls, **you're done!** You successfully instrumented your app! Now you're ready to turn on any destination you fancy from our interface, margarita in hand.
139139

140-
---
141-
142140
## What's Next?
143141

144142
We just walked through the quickest way to get started with Segment using Analytics-Android. You might also want to check out Segment's full [Analytics-Android reference](/docs/connections/sources/catalog/libraries/mobile/android) to see what else is possible, or read about the [Tracking API methods](/docs/connections/sources/catalog/libraries/server/http-api/) to get a sense for the bigger picture.

0 commit comments

Comments
 (0)