Skip to content

Commit a99b89f

Browse files
committed
alt-text
1 parent 861e453 commit a99b89f

24 files changed

+74
-74
lines changed

src/partners/conceptual-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Apps represent a unit of functionality that Segment users can add to their works
3030
- Within Destinations, we have Streaming Destinations, Batch Destinations, and Warehouse Destinations, all of which receive different data, using different processes, at different intervals and with varying degrees of control and flexibility.
3131
- On the Sources side, integrations are categorized based on whether they send Objects or Events, whether they are "Push" or "Pull," and whether they are built and hosted by Segment or by Partners.
3232

33-
![](images/product-model.svg)
33+
![Diagram showing how events are processed in Segment.](images/product-model.svg)
3434

3535
These smaller pieces that support the source and destination model are called "Components".
3636

src/partners/streams.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To complete the source set up flow, the customer will need to input the Segment
1818

1919
Customers can find their write key in the source settings and regenerate it as needed.
2020

21-
![](images/s_8E933880F61B29168308B8A8203AE878319289A26E8E2054D0824C7A53E43DD4_1479162638952_file.png)
21+
![Screenshot of a Source's settings page, with the write key present.](images/s_8E933880F61B29168308B8A8203AE878319289A26E8E2054D0824C7A53E43DD4_1479162638952_file.png)
2222

2323
> warning ""
2424
> Segment working on an OAuth solution to reduce friction for customers. Partner Streams submitted through the developer center *will* be required to support this OAuth as it comes available.

src/partners/subscriptions/build-functions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Review the steps outlined in the [Developer Center Overview](/docs/partners). Th
2727

2828
Begin by selecting the _Subscription_ card in your Developer Center UI after creating an App and selecting _I want Segment to run functions I write_. Next, you will see the code editor where you can take full control of your Subscriptions's logic. Segment provides boilerplate functions that make it simple to send data to your API Endpoint. You can delete the example code and implement your own functions.
2929

30-
![](/docs/partners/images/developer_center_customcode_page.png)
30+
![Screenshot of the Build tab in the Developer Center.](/docs/partners/images/developer_center_customcode_page.png)
3131

3232
For every event you send to Segment, Segment invokes a function you provide for the event type. So you must define functions named after every type in the [Segment Spec](/docs/connections/spec/) that you support:
3333

@@ -186,7 +186,7 @@ When testing your integration, proceed through two separate flows:
186186

187187
Test your code directly from the Developer Center UI. Use the `Send Test Event` button and review the test event to make sure your function works as expected.
188188

189-
![](/docs/partners/images/developer_center_customcode_test.png)
189+
![Screenshot of the Build tab in the Developer Center, with a View Output button selected in the test event panel.](/docs/partners/images/developer_center_customcode_test.png)
190190

191191
In the debugger panel, check the two outputs. The **Callback Return** and the **Log Output**.
192192

@@ -195,7 +195,7 @@ In the debugger panel, check the two outputs. The **Callback Return** and the **
195195

196196
When your code is working with one event you can test it with a suite of more Segment events. Click `Save and Next: Test`, fill in an `API Key` and click `Test`. You will see the results of additional types of Segment data.
197197

198-
![](/docs/partners/images/developer_center_test_suite.png)
198+
![Screenshot of the Test tab in the Developer Center, which shows the results for each Segment Spec method.](/docs/partners/images/developer_center_test_suite.png)
199199

200200
### The User Flow
201201

@@ -211,7 +211,7 @@ Now you can use the JavaScript SDK in a browser to generate real analytics event
211211

212212
Finally you should verify the data in your service.
213213

214-
![](/docs/partners/images/test-destination.gif)
214+
![Animation showing someone configure a custom app, enable the app, and test three events.](/docs/partners/images/test-destination.gif)
215215

216216

217217
## Handling deletions

src/partners/subscriptions/build-webhook.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ See the [headers](#headers) section for more details.
5151
#### Custom Settings
5252
All subscriptions have an API key setting by default, which Segment will send in the Authorization Header. To add more custom settings, go to the `Settings Builder` page under `App Info`.
5353

54-
![](/docs/partners/images/developer_center_settings_builder.png)
54+
![Screenshot of the Settings Builder page.](/docs/partners/images/developer_center_settings_builder.png)
5555

5656
Any custom settings you add will be sent in the custom header `X-Segment-Settings` (See the [headers](#headers) section for more details.)
5757

@@ -159,7 +159,7 @@ When testing your integration, proceed through two separate flows:
159159

160160
Test your code directly from the Developer Center UI. Use the `Send Test Event` button and review the test event to make sure your function works as expected.
161161

162-
![](/docs/partners/images/developer_center_customcode_test.png)
162+
![Screenshot of the Build tab in the Developer Center, with a View Output button selected in the test event panel.](/docs/partners/images/developer_center_customcode_test.png)
163163

164164
In the debugger panel, check the two outputs. The **Callback Return** and the **Log Output**.
165165

@@ -168,7 +168,7 @@ In the debugger panel, check the two outputs. The **Callback Return** and the **
168168

169169
When your code is working with one event you can test it with a suite of more Segment events. Click `Save and Next: Test`, fill in an `API Key` and click `Test`. You will see the results of additional types of Segment data.
170170

171-
![](/docs/partners/images/developer_center_test_suite.png)
171+
![Screenshot of the Test tab in the Developer Center, which shows the results for each Segment Spec method.](/docs/partners/images/developer_center_test_suite.png)
172172

173173
### The User Flow
174174

@@ -184,7 +184,7 @@ Now you can use the JavaScript SDK in a browser to generate real analytics event
184184

185185
Finally you should verify the data in your service.
186186

187-
![](/docs/partners/images/test-destination.gif)
187+
![Animation showing someone configure a custom app, enable the app, and test three events.](/docs/partners/images/test-destination.gif)
188188

189189
## Next Steps
190190

src/privacy/data-controls.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ other tools you might prefer for events and notifications. We recommend setting
3535
up alerts to help you ensure your Inventory is always up to date.
3636

3737

38-
![](images/privacy-alerts.png)
38+
![Screenshot of the Privacy Portal settings page in the Segment app.](images/privacy-alerts.png)
3939

4040

4141
**To set up a Slack Alert:**

src/privacy/portal.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ You can click a row in the Inbox to learn more about a field and where it was co
3535
- an example code snippet containing a payload that the field appears in
3636

3737

38-
![](images/privacy-inbox.gif)
38+
![Animation of a user selecting a row in the Privacy Portal and clicking on the expanded view.](images/privacy-inbox.gif)
3939

4040

4141
To streamline the classification process, Segment pre-classifies the data in the
@@ -56,7 +56,7 @@ dropdown menu to change. For example, you might manually change a field that
5656
does not contain personal information in your implementation from a "Yellow"
5757
classification to "Green."
5858

59-
![](images/privacy-inbox-change-color.gif)
59+
![Animation of a user selecting the color dropdown menu and changing the phone field from a Yellow field to a Green field.](images/privacy-inbox-change-color.gif)
6060

6161

6262
When you're satisfied that the fields have been classified appropriately, you
@@ -86,7 +86,7 @@ The Inventory is a central repository of all of the properties _you_ classified
8686

8787
Once you've classified the fields as Red, Yellow, and Green in the Inbox, the classified fields appear in the Inventory. You can use the filter at the top left to filter down to specific categories of data (for example, Red data, data from a production environment, data from specific sources).
8888

89-
![](images/privacy-inventory-filtering.gif)
89+
![Animation of a user filtering the data inventory to only show red fields in their production environment that came from Clearbrain.](images/privacy-inventory-filtering.gif)
9090

9191
Click into a field (for example, `ip`) in the Inventory to open the Inventory
9292
details. The details sheet displays how many times a specific field has been
@@ -100,7 +100,7 @@ connected to the Source that contains the field. The Access tab displays a list
100100
of who within your organization has access to this field.
101101

102102

103-
![](images/privacy-inventory-overview.png)
103+
![Screenshot of the product_id Inventory details page in the Privacy Portal.](images/privacy-inventory-overview.png)
104104

105105

106106
Finally, workspace owners can use the **Download CSV** button to export a CSV of
@@ -207,10 +207,10 @@ treat that property whenever it is appears in data Segment processes.
207207
- **Similar to** matches a **Key** that is similar to a term within a fuzzy string distance (for example "email" and "e-mail"). We built fuzzy matching using [this public GitHub repository](https://github.com/imjasonmiller/godice). If the score is > 0.7, then we say it's a match.
208208

209209

210-
![](images/privacy-add-new-matcher.gif)
210+
![Animation of a user creating a new matcher, SIN, with the exact matching setting selected.](images/privacy-add-new-matcher.gif)
211211

212212

213-
![](images/privacy-edit-matcher.png)
213+
![Screenshot of the Edit Matcher popup.](images/privacy-edit-matcher.png)
214214

215215

216216
Unless the field value pattern is unique, we recommend matching on the Key. For

src/protocols/apis-and-extensions/anomaly_detection.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Regardless of the solution you choose, we recommend that you create a new Segmen
2929

3030
Next, set up [Violation forwarding](/docs/protocols/validate/forward-violations/) for each Tracking Plan connected to the Source. Once connected, your sources will look like:
3131

32-
![](images/protocols_meta_source_setup.png)
32+
![Diagram showing how violations and production events are routed to their respective destinations.](images/protocols_meta_source_setup.png)
3333

3434
**Note: When you enable violation forwarding, it counts as 1 MTU toward your monthly MTU limit. If you are on an API plan, all forwarded violations count against your API limit. Violations might also generate costs in downstream destinations and data warehouses.**
3535

@@ -49,13 +49,13 @@ Source: {% raw %}`{{properties.sourceName}}` \nEvent: `{{properties.eventName}}`
4949
```
5050
When you're done, it'll look like the screenshot below.
5151

52-
![](images/slack_violation_generated_setup.png)
52+
![Screenshot of a Slack destination settings page with Segment Event Name and Event Template fields filled out. The Event Template follows the convention outlined above.](images/slack_violation_generated_setup.png)
5353

5454

5555
### Create customized Anomaly Detection dashboards in a BI tool
5656
Custom dashboards are a great way to focus your teams around the metrics and events that matter most to your business. With a few simple queries you can build a dashboard to share with teams, so everyone can understand how well they're doing against your data quality objectives. Here's an example dashboard that combines [forwarded Violations](/docs/protocols/validate/forward-violations/) with production event data to track data quality. See below for detailed SQL queries!
5757

58-
![](images/anomaly_detection_dashboard.png)
58+
![Graphic with five bar charts created with sample data, showing different comparisons of violations across events and sources.](images/anomaly_detection_dashboard.png)
5959

6060
Note: For all queries below, replace `protocols_audit_source` with whatever schema name you set for your forwarded violations source.
6161

src/protocols/starter.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ You can add the Tracking Plan Read Only role to workspace members, or to groups
2525
To see your Tracking Plan, click **Protocols** in the left navigation. The first time you visit this section, the Segment App shows an explanation of tracking plans, which you can dismiss. Click **Create Tracking Plan** to get started.
2626

2727

28-
![](images/starter-tp-intro.png)
28+
![Screenshot of the Protocols page in the Segment app.](images/starter-tp-intro.png)
2929

3030

3131
From the screen that appears, click **Add Events** to add your first event to the tracking plan.
3232

3333

34-
![](images/starter-tp-empty.png)
34+
![Screenshot of the Tracking Plan setup page in the Segment app.](images/starter-tp-empty.png)
3535

3636

3737

@@ -45,15 +45,15 @@ On the next page, you'll select the events that you need from the Segment Standa
4545
3. Click **Next** to review properties on the events.
4646

4747

48-
![](images/starter-tp-add-events.png)
48+
![Screenshot of the Select Events page on the Add events from templates popup, with Button Clicked, Demo Request Button Clicked, and Demo Requested selected.](images/starter-tp-add-events.png)
4949

5050

5151

5252
The next screen shows the Events you chose and their properties. Properties are how you enrich the raw event data with useful context, which allows you to perform useful analysis and alerting. These standard events have a minimum set of properties based on what we know about the event type, and how it is usually used. You can add extra custom properties in the next step.
5353

5454
Expand each event to view its properties. If you decide you want to add or remove Events, click **Previous** to go back to the event list. When you're satisfied that you've selected Standard Events for all of the activities on your site, click **Add**.
5555

56-
![](images/starter-tp-review-props.png)
56+
![Screenshot of the Review Properties page on the Add events from templates popup, with all event properties selected.](images/starter-tp-review-props.png)
5757

5858

5959

@@ -65,15 +65,15 @@ You might want to add extra properties to the Segment standard events, for examp
6565

6666
To add a custom property, click the **plus** icon next to the event that the property should be attached to.
6767

68-
![](images/starter-tp-view-event-details.png)
68+
![Screenshot of the Tracking Plan page, with the plus icon next to the Demo Requested event highlighted.](images/starter-tp-view-event-details.png)
6969

7070

7171
In the dialog that appears, enter the name and type of the property, and add a description.
7272

7373
You can click **Save and add more** to add more than one property, or click **Save and exit** when you're satisfied that you've added all the properties you'll need.
7474

7575

76-
![](images/starter-tp-add-prop.png)
76+
![Screenshot of the Add property popup.](images/starter-tp-add-prop.png)
7777

7878

7979

@@ -83,7 +83,7 @@ The Tracking Plan page shows an overview of the data that is arriving to your Se
8383

8484
You can click each event in the table to expand it, view the event description, and view its properties and their descriptions. Property descriptions include the expected data type for each property.
8585

86-
![](images/starter-tp-seen.png)
86+
![Screenshot of the Tracking Plan page, with the Sources Seen icon selected.](images/starter-tp-seen.png)
8787

8888
The **Sending** column shows the number of Events Segment has seen with that description and format. You can expand this to see how many of the events Segment saw for Dev, Test, and Production sources. If you see a 0 in this column for all sources, this usually means that the event has not been implemented yet, or has not been implemented correctly.
8989

src/protocols/tracking-plan/libraries.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ To create a new Library:
1919
2. Click **Libraries** in the top navigation bar
2020
3. Click **New Library** and follow the steps to create an event or property library
2121

22-
![](../images/property_library_example.png)
22+
![Screenshot of the Ecommerce Properties Library.](../images/property_library_example.png)
2323

2424
### Tracking Plan Event Libraries
2525

@@ -33,7 +33,7 @@ Tracking Plan property Libraries support Track event property groups. Property L
3333

3434
You can import event and property libraries into a Tracking Plan. Enter the Draft mode for a Tracking Plan and click the **Import from Event or Property Library** dropdown. A wizard will appear allowing you to either add the events to a tracking plan, or add properties to selected events already in the tracking plan. After adding your events or properties, remember to merge your changes!
3535

36-
![](../images/import_library_to_tracking_plan.gif)
36+
![Animation of a user importing events into their Tracking Plan using a Tracking Plan library.](../images/import_library_to_tracking_plan.gif)
3737

3838
### Library syncing
3939

@@ -47,5 +47,5 @@ Syncing a Library makes events and properties un-editable, and bypasses the Trac
4747
> warning ""
4848
> All changes made to a synced library pass through to the Tracking Plans and may impact data deliverability
4949
50-
![](../images/unsync_library.png)
50+
![Screenshot of the Synced Libraries page, with the overflow menu selected and the Unsync from Tracking setting visible.](../images/unsync_library.png)
5151

src/protocols/validate/connect-sources.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ redirect_from: '/protocols/validate/'
88

99
With your Tracking Plan is complete, it's time to apply the Tracking Plan to one or more Sources. Select **Connect Source** from the right hand menu for your specific Tracking Plan.
1010

11-
![](../images/5763308453_Screen+Shot+2018-08-31+at+5.54.18+PM.png)
11+
![Screenshot of the Tracking Plans page, with the overflow menu selected.](../images/5763308453_Screen+Shot+2018-08-31+at+5.54.18+PM.png)
1212

1313

1414
From this menu, you will be redirected to a workflow to select a Source from your workspace. Note that a Source can only have one tracking plan applied to it. You *can't* select a Source that already has a Tracking Plan connected to it, but you *can* apply a Tracking Plan to multiple sources.
@@ -17,10 +17,10 @@ After selecting a Source, you will be shown the consequences of connecting your
1717

1818
**IMPORTANT: Make sure to read through the consequences of connecting a source!**
1919

20-
![](../images/5763823424_Image+2018-08-31+at+6.02.54+PM.png)
20+
![Screenshot of the Review Consequences page, with one type and consequence detail present on the page.](../images/5763823424_Image+2018-08-31+at+6.02.54+PM.png)
2121

2222
## Disconnect Source from Tracking Plan
2323

2424
To disconnect the Source from the Tracking Plan, go to the Tracking Plan overview page, locate the column for the tracking plan you want to disconnect, then click the icon under the **Connected Sources**. In the settings that appear, click **Disconnect** next to the Source you want to disconnect.
2525

26-
![](../images/protocols_disconnect_source.gif)
26+
![Animation of a user clicking on one of the sources attached to a tracking plan, clicking the disconnect button, and then confirming on a Disconnect source popup.](../images/protocols_disconnect_source.gif)

0 commit comments

Comments
 (0)