Skip to content

Commit c4280ec

Browse files
authored
Merge branch 'master' into DOC-181_adjust_clarification
2 parents 7a0ed9a + 5a46861 commit c4280ec

File tree

9 files changed

+143
-58
lines changed

9 files changed

+143
-58
lines changed

src/_data/catalog/overrides-list.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
items:
2+
- hubspot
3+
- iterable

src/_data/catalog/overrides.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# This file is manually generated. When you add or remove an item, add or remove
2+
# it from the `overrides-list.yml` too.
13
items:
24
- slug: hubspot
35
components:
@@ -13,7 +15,7 @@ items:
1315
mobile: true
1416
server: true
1517
summary: >-
16-
accepts data from any Segment mobile or server source in cloud mode.
18+
accepts data from any Segment mobile or server source in cloud mode.
1719
It does not accept data from a web source, and does not offer device-mode connections.
1820
cmode_type: mixed
1921
case: '6'
@@ -33,4 +35,4 @@ items:
3335
summary: >-
3436
accepts cloud-mode data from all Segment source types. It does not offer device-mode connections.
3537
cmode_type: mixed
36-
case: '5'
38+
case: '5'

src/_data/catalog/warehouse.yml

Lines changed: 59 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,27 @@
11
# Manually generated
22
items:
3-
- display_name: Redshift
4-
slug: redshift
5-
name: catalog/warehouses/redshift
6-
description: ''
7-
url: connections/storage/catalog/redshift
3+
- display_name: Amazon S3
4+
slug: amazon-s3
5+
name: catalog/warehouses/amazon-s3
6+
description: >-
7+
Our Amazon S3 copies our log files of your raw API calls from our S3 bucket
8+
to yours, where you can then perform custom analysis on them.
9+
url: connections/storage/catalog/amazon-s3
810
status: PUBLIC
911
logo:
10-
url: 'https://d3hotuclm6if1r.cloudfront.net/logos/redshift-default.svg'
12+
url: 'https://d3hotuclm6if1r.cloudfront.net/logos/amazon-s3-default.svg'
1113
mark:
12-
url: ''
13-
categories:
14-
- Warehouses
15-
16-
- display_name: Segment Data Lakes
17-
slug: data-lakes
18-
name: catalog/warehouse/data-lakes
14+
url: 'https://cdn.filepicker.io/api/file/R1EKddJ1SnGECiHtdUlY'
15+
- display_name: Azure Synapse Analytics Warehouse
16+
slug: azuresqldw
17+
name: catalog/warehouses/azuresqldw
1918
description: ''
20-
url: connections/storage/catalog/data-lakes
21-
status: PUBLIC_BETA
19+
url: connections/storage/catalog/azuresqldw
20+
status: PUBLIC
2221
logo:
23-
url: 'https://cdn.filepicker.io/api/file/YR7dKXAiQWyYvBiVOZNX'
22+
url: 'https://cdn.filepicker.io/api/file/VKbuWjNjQPKOnOWijFe4'
2423
mark:
25-
url: 'https://cdn.filepicker.io/api/file/zKQw43MuQjmTtXBXs4VL'
24+
url: 'https://cdn.filepicker.io/api/file/EUJvt69Q7qMqCvGrVtiu'
2625
categories:
2726
- Warehouses
2827
- display_name: BigQuery
@@ -37,6 +36,30 @@ items:
3736
url: 'https://cdn.filepicker.io/api/file/Vk6iFlMvQeynbg30ZEtt'
3837
categories:
3938
- Warehouses
39+
- display_name: Google Cloud Storage
40+
slug: google-cloud-storage
41+
name: catalog/warehouses/google-cloud-storage
42+
description: ''
43+
url: connections/storage/catalog/google-cloud-storage
44+
status: PUBLIC_BETA
45+
logo:
46+
url: 'https://cdn.filepicker.io/api/file/G6kRHZtSoaEslLkENhPC'
47+
mark:
48+
url: ''
49+
categories:
50+
- Warehouses
51+
- display_name: IBM Db2 Warehouse
52+
slug: db2
53+
name: catalog/warehouses/db2
54+
description: ''
55+
url: connections/storage/catalog/db2
56+
status: PUBLIC
57+
logo:
58+
url: 'https://image.ibb.co/i4rS3K/IBM_Db2_logotype_pos_RGB.jpg'
59+
mark:
60+
url: ''
61+
categories:
62+
- Warehouses
4063
- display_name: Postgres
4164
slug: postgres
4265
name: catalog/warehouses/postgres
@@ -49,54 +72,42 @@ items:
4972
url: ''
5073
categories:
5174
- Warehouses
52-
- display_name: Snowflake
53-
slug: snowflake
54-
name: catalog/warehouses/snowflake
75+
- display_name: Redshift
76+
slug: redshift
77+
name: catalog/warehouses/redshift
5578
description: ''
56-
url: connections/storage/catalog/snowflake
79+
url: connections/storage/catalog/redshift
5780
status: PUBLIC
5881
logo:
59-
url: 'https://cdn.filepicker.io/api/file/JrQWOYvMRRCVvSHp4HL0'
82+
url: 'https://d3hotuclm6if1r.cloudfront.net/logos/redshift-default.svg'
6083
mark:
61-
url: 'https://cdn.filepicker.io/api/file/OBhrGoCRKaSyvAhDX3fw'
84+
url: ''
6285
categories:
6386
- Warehouses
64-
- display_name: IBM Db2 Warehouse
65-
slug: db2
66-
name: catalog/warehouses/db2
87+
- display_name: Segment Data Lakes
88+
slug: data-lakes
89+
name: catalog/warehouse/data-lakes
6790
description: ''
68-
url: connections/storage/catalog/db2
69-
status: PUBLIC
91+
url: connections/storage/catalog/data-lakes
92+
status: PUBLIC_BETA
7093
logo:
71-
url: 'https://image.ibb.co/i4rS3K/IBM_Db2_logotype_pos_RGB.jpg'
94+
url: 'https://cdn.filepicker.io/api/file/YR7dKXAiQWyYvBiVOZNX'
7295
mark:
73-
url: ''
96+
url: 'https://cdn.filepicker.io/api/file/zKQw43MuQjmTtXBXs4VL'
7497
categories:
7598
- Warehouses
76-
- display_name: Azure Synapse Analytics Warehouse
77-
slug: azuresqldw
78-
name: catalog/warehouses/azuresqldw
99+
- display_name: Snowflake
100+
slug: snowflake
101+
name: catalog/warehouses/snowflake
79102
description: ''
80-
url: connections/storage/catalog/azuresqldw
103+
url: connections/storage/catalog/snowflake
81104
status: PUBLIC
82105
logo:
83-
url: 'https://cdn.filepicker.io/api/file/VKbuWjNjQPKOnOWijFe4'
106+
url: 'https://cdn.filepicker.io/api/file/JrQWOYvMRRCVvSHp4HL0'
84107
mark:
85-
url: 'https://cdn.filepicker.io/api/file/EUJvt69Q7qMqCvGrVtiu'
108+
url: 'https://cdn.filepicker.io/api/file/OBhrGoCRKaSyvAhDX3fw'
86109
categories:
87110
- Warehouses
88-
- display_name: Amazon S3
89-
slug: amazon-s3
90-
name: catalog/warehouses/amazon-s3
91-
description: >-
92-
Our Amazon S3 copies our log files of your raw API calls from our S3 bucket
93-
to yours, where you can then perform custom analysis on them.
94-
url: connections/storage/catalog/amazon-s3
95-
status: PUBLIC
96-
logo:
97-
url: 'https://d3hotuclm6if1r.cloudfront.net/logos/amazon-s3-default.svg'
98-
mark:
99-
url: 'https://cdn.filepicker.io/api/file/R1EKddJ1SnGECiHtdUlY'
100111

101112
settings:
102113
- name: bucket

src/_layouts/default.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,15 @@
4646
{%- endif -%}
4747
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css"/>
4848
<link rel="icon" href="https://segment.com/favicon.ico">
49+
4950
{%- if jekyll.environment == "production" -%}
5051
{%- assign hostname = "https://segment.com" -%}
5152
{%- elsif jekyll.environment == "staging" -%}
5253
{%- assign hostname = "https://segment.build" -%}
5354
{%- else -%}
5455
{%- assign hostname = "" -%}
5556
{%- endif -%}
56-
<link rel="canonical" href="{{hostname}}/docs{{page.url}}" />
57+
<link rel="canonical" href="{{site.url}}/docs{{page.url}}" />
5758
<meta name="application-name" content="Segment">
5859
<meta name="theme-color" content="#00386C">
5960
<meta charset="utf-8">

src/connections/destinations/category-compare.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: Destination comparison by category
33
---
44

55
This page collates information about each destination, organized by category for better comparison shopping.
6+
{% assign overridesList = site.data.catalog.overrides-list.items %}
67

78
{% for category in site.data.catalog.destination_categories.items %}
89

@@ -27,12 +28,21 @@ This page collates information about each destination, organized by category for
2728
{% unless destination.connection_modes.cloud.web == false and destination.connection_modes.cloud.mobile == false and destination.connection_modes.cloud.server == false and destination.connection_modes.device.web == false and destination.connection_modes.device.mobile == false %}
2829
<tr>
2930
<td>**[{{ destination.display_name }}](/docs/{{ destination.url }})**</td>
30-
<td style="border-left: 1px solid gray;">{% if destination.connection_modes.cloud.web %}✅{% else %}⬜️{% endif %} </td>
31+
{% if overridesList contains destination.slug %}{% assign thisDestname = destination.slug %}{% assign thisDest = site.data.catalog.overrides.items | where: "slug", thisDestname | first%}
32+
<td style="border-left: 1px solid gray;">
33+
{% if thisDest.connection_modes.cloud.web %}✅{% else %}⬜️{% endif %} </td>
34+
<td>{% if thisDest.connection_modes.cloud.mobile %}✅{% else %}⬜️{% endif %} </td>
35+
<td>{% if thisDest.connection_modes.cloud.server %}✅{% else %}⬜️{% endif %} </td>
36+
<td style="border-left: 1px solid gray;">{% if thisDest.connection_modes.device.web %}✅{% else %}⬜️{% endif %} </td>
37+
<td>{% if thisDest.connection_modes.device.mobile %}✅{% else %}⬜️{% endif %} </td>
38+
{% else %}
39+
<td style="border-left: 1px solid gray;">
40+
{% if destination.connection_modes.cloud.web %}✅{% else %}⬜️{% endif %} </td>
3141
<td>{% if destination.connection_modes.cloud.mobile %}✅{% else %}⬜️{% endif %} </td>
3242
<td>{% if destination.connection_modes.cloud.server %}✅{% else %}⬜️{% endif %} </td>
3343
<td style="border-left: 1px solid gray;">{% if destination.connection_modes.device.web %}✅{% else %}⬜️{% endif %} </td>
3444
<td>{% if destination.connection_modes.device.mobile %}✅{% else %}⬜️{% endif %} </td>
35-
</tr>
45+
{%endif%}</tr>
3646
{% endunless %}
3747
{% endif %}
3848
{% endfor %}

src/connections/destinations/cmodes-compare.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ title: Destinations Connection Modes comparison
77
88
> success ""
99
> Comparison shopping? Check out the [destination connection modes by category](/docs/connections/destinations/category-compare/).
10+
{% assign overridesList = site.data.catalog.overrides-list.items %}
1011

1112
<table>
1213
<tr>
@@ -26,12 +27,23 @@ title: Destinations Connection Modes comparison
2627
{% unless destination.connection_modes.cloud.web == false and destination.connection_modes.cloud.mobile == false and destination.connection_modes.device.web == false and destination.connection_modes.device.mobile == false and destination.connection_modes.cloud.server == false %}
2728
<tr>
2829
<td>[{{ destination.display_name }}](/docs/{{ destination.url }}){% if destination.status == "PUBLIC_BETA" %}&nbsp;ℹ️{% endif %}</td>
29-
<td style="border-left: 1px solid gray;">{% if destination.connection_modes.cloud.web %}✅{% else %}⬜️{% endif %} </td>
30+
{% if overridesList contains destination.slug %}{% assign thisDestname = destination.slug %}{% assign thisDest = site.data.catalog.overrides.items | where: "slug", thisDestname | first%}
31+
<td style="border-left: 1px solid gray;">
32+
{% if thisDest.connection_modes.cloud.web %}✅{% else %}⬜️{% endif %} </td>
33+
<td>{% if thisDest.connection_modes.cloud.mobile %}✅{% else %}⬜️{% endif %} </td>
34+
<td>{% if thisDest.connection_modes.cloud.server %}✅{% else %}⬜️{% endif %} </td>
35+
<td style="border-left: 1px solid gray;">{% if thisDest.connection_modes.device.web %}✅{% else %}⬜️{% endif %} </td>
36+
<td>{% if thisDest.connection_modes.device.mobile %}✅{% else %}⬜️{% endif %} </td>
37+
{% else %}
38+
<td style="border-left: 1px solid gray;">
39+
{% if destination.connection_modes.cloud.web %}✅{% else %}⬜️{% endif %} </td>
3040
<td>{% if destination.connection_modes.cloud.mobile %}✅{% else %}⬜️{% endif %} </td>
3141
<td>{% if destination.connection_modes.cloud.server %}✅{% else %}⬜️{% endif %} </td>
3242
<td style="border-left: 1px solid gray;">{% if destination.connection_modes.device.web %}✅{% else %}⬜️{% endif %} </td>
3343
<td>{% if destination.connection_modes.device.mobile %}✅{% else %}⬜️{% endif %} </td>
44+
{%endif%}
3445
</tr>
46+
3547
{% endunless %}
3648
{% endfor %}
3749
</table>

src/connections/destinations/index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,22 +18,23 @@ Segment has five types of sources: Web (Analytics.js), Mobile, Server, and Cloud
1818

1919
## Method Compatibility
2020

21-
Not all destinations can accept data from specific method types. Wondering which ones are which? Check out the [Destinations Methods matrix](/docs/connections/destinations/methods-compare/).
21+
Not all destinations can accept data from specific method types. Wondering which ones are which? Look for the "Quick Info" box at the top of the destination's documentation page, or check out the [Destinations Methods matrix](/docs/connections/destinations/methods-compare/).
2222

2323
## Source Compatibility
2424

25-
Many destinations can accept data from all types of sources, but some are only compatible with specific source types (for example, web only, or server only). To find out which source types a specific destination can accept data from, check the documentation for that destination for a "Supported Sources and Connection Modes" section.
25+
Many destinations can accept data from all types of sources, but some are only compatible with specific source types (for example, web only, or server only). To find out which source types a specific destination can accept data from, check the documentation for that destination for a "Quick info" box, or a "Supported Sources and Connection Modes" section.
2626

2727
{% include components/reference-button.html href="/docs/connections/destinations/category-compare/" icon="guides.svg" title="Destinations Compatibility Matrix" description="Wondering which destinations take which data? Check out the Destination connection modes list by category." %}
2828

29+
2930
## Connection Modes
3031

3132
{% include content/connection-modes-intro.md %}
3233

3334

3435
### When should I use Device-mode? When should I use Cloud-mode?
3536

36-
There are two main things we consider when we decide to build Device- or Cloud-Modes (or both!) for a destination partner
37+
There are two main things we consider when Segment decides to use Device- or Cloud-Modes (or both!) for a destination partner
3738

3839
#### 1. Anonymous Attribution Methodology
3940

src/connections/sources/catalog/libraries/website/javascript/index.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -698,3 +698,33 @@ Analytics.js uses `localstorage` cookies if you have retries enabled, to keep tr
698698
For more information, visit the [Segment localstorage-retry library](https://github.com/segmentio/localstorage-retry).
699699

700700
You can set the `debug` cookie to `analytics.js` to log debug messages from Analytics.js to the console.
701+
702+
## Open source libraries
703+
704+
Analytics.js 2.0 includes the following open source components:
705+
706+
**uuid v2.0.0** ([https://github.com/lukeed/uuid](https://github.com/lukeed/uuid))
707+
Copyright Luke Edwards <[[email protected]](mailto:[email protected])> ([lukeed.com](https://lukeed.com/))
708+
License: MIT License, available here: [https://github.com/lukeed/uuid/blob/master/license](https://github.com/lukeed/uuid/blob/master/license)
709+
710+
**component-url v0.2.1** ([https://github.com/component/url](https://github.com/component/url))
711+
Copyright (c) 2014 Component
712+
License: MIT License, available here: [https://github.com/component/url/blob/master/Readme.md](https://github.com/component/url/blob/master/Readme.md)
713+
714+
**dset v2.0.1** ([https://github.com/lukeed/dset](https://github.com/lukeed/dset))
715+
Copyright (c) Luke Edwards <[[email protected]](mailto:[email protected])> ([lukeed.com](https://lukeed.com/))
716+
License: MIT License, available here: [https://github.com/lukeed/dset/blob/master/license](https://github.com/lukeed/dset/blob/master/license)
717+
718+
**js-cookie v2.2.1**
719+
Copyright (c) 2018 Copyright 2018 Klaus Hartl, Fagner Brack, GitHub Contributors
720+
  License: MIT License, available here: [https://github.com/js-cookie/js-cookie/blob/master/LICENSE](https://github.com/js-cookie/js-cookie/blob/master/LICENSE)
721+
722+
**md5 v2.3.0** ([https://github.com/pvorb/node-md5](https://github.com/pvorb/node-md5))
723+
Copyright (c) 2011-2012, Paul Vorbach.
724+
Copyright (c) 2009, Jeff Mott.
725+
License: BSD-3-Clause “New” or “Revised” License, available at:
726+
[https://github.com/pvorb/node-md5/blob/master/LICENSE](https://github.com/pvorb/node-md5/blob/master/LICENSE)
727+
728+
**unfetch v4.1.0** ([https://github.com/developit/unfetch](https://github.com/developit/unfetch))
729+
Copyright (c) 2017 Jason Miller
730+
License: MIT License, available at: [https://github.com/developit/unfetch/blob/master/LICENSE.md](https://github.com/developit/unfetch/blob/master/LICENSE.md)

src/connections/sources/catalog/libraries/website/javascript/upgrade-to-ajs2.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,19 @@ Analytics.js sources will upgrade to Analytics.js 2.0 on the date below, accordi
3131
3232
## Revert to Analytics.js Classic
3333

34-
Once a source moves to Analytics.js 2.0, you can follow the steps above in [Manual migration](#manual-migration) back to roll back to Analytics.js Classic.
34+
Once a source moves to Analytics.js 2.0, you can follow the steps above in [Manual migration](#manual-migration) back to roll back to Analytics.js Classic.
35+
36+
## Cases that require additional intervention
37+
38+
There are two cases where upgrading to Analytics.js 2.0 requires manual effort beyond enabling the Analytics.js 2.0 toggle.
39+
40+
### When using in-domain instrumentation CDN aliasing
41+
42+
If the source you intend to upgrade uses the in-domain instrumentation as well as a custom "Alias for analytics.js", then you should update the AJS snippet to the latest version (4.13.2 or higher) before you toggle on Analytics.js 2.0.
43+
44+
### When using a strict content security policy on the page
45+
46+
Analytics.js 2.0 asynchronously loads different pieces of the library as needed. If the source you're upgrading uses a strict Content Security Policy (CSP) that allows Javascript to be downloaded from specific locations, then you need to update the CSP to account for all the pieces used for Analytics.js 2.0. Therefore, beyond allowing the main analytics.min.js script, you should allow the following paths in your CSP:
47+
- `https://cdn.segment.com/v1/projects/<WRITE_KEY>/settings`
48+
- `https://cdn.segment.com/analytics-next/bundles/*`
49+
- `https://cdn.segment.com/next-integrations/integrations/*`

0 commit comments

Comments
 (0)