Skip to content

Commit fa1a0bd

Browse files
committed
Merge branch 'master' into DOC_131-Algolia
2 parents 1f132f6 + 74a1573 commit fa1a0bd

File tree

8 files changed

+60
-7
lines changed

8 files changed

+60
-7
lines changed

src/_data/sidenav/strat.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@ sections:
8383
section:
8484
- path: /connections/sources/catalog/libraries/website/javascript
8585
title: Analytics.js (Javascript) Source
86-
# - path: /connections/sources/catalog/libraries/website/javascript/analytics-js-2
87-
# title: Analytics.js 2.0 (Beta)
86+
- path: /connections/sources/catalog/libraries/website/javascript/analytics-js-2
87+
title: Analytics.js 2.0 (Beta)
8888
- path: /connections/sources/catalog/libraries/website/javascript/supported-browsers
8989
title: Analytics.js supported browsers
9090
- path: /connections/sources/catalog/libraries/website/javascript/quickstart
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Analytics.js 2.0
3+
description: |
4+
Analytics.js is Segment’s most popular library source. This new major version has been re-engineered to be more performant and provide greater extensibility. It is fully backwards compatible with the previous version of Analytics.js.
5+
release_type: beta
6+
product_area: sources
7+
business: false
8+
team: false
9+
doc_links:
10+
-
11+
title: Analytics.js 2.0 (Beta)
12+
url: "/docs/connections/sources/catalog/libraries/website/javascript/analytics-js-2/"
13+
# images:
14+
# -
15+
# path: /images/release-notes/ui-update-1.png
16+
# desc: The navigation was redesigned to better reflect how users navigate through the product.
17+
# -
18+
# path: /images/release-notes/ui-update-2.gif
19+
# desc: A new workspace switcher provides an easier way to navigate between workspaces.
20+
---

src/_sass/vendors/_premonition.scss

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,9 @@
103103
margin-top: 0px;
104104
}
105105

106-
& > *:not(.header, ul) + * {
107-
margin-top: 25px;
108-
}
106+
// & > *:not(.header, ul) + * {
107+
// margin-top: 25px;
108+
// }
109109

110110
& > * + * {
111111
margin-top: 5px;

src/connections/destinations/catalog/google-cloud-function/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ strat: google
77

88
Segment makes it easy to send your data to Google Cloud Function (and lots of other destinations). Once you collect your data using Segment's [open source libraries](/docs/connections/sources/catalog/), Segment translates and routes your data to Google Cloud Function in a format it can use.
99

10-
[Google Cloud Function](https://cloud.google.com/function) is a lightweight compute solution for developers to create single-purpose, stand-alone functions that respond to Cloud events without the need to manage a server or runtime environment.
10+
[Google Cloud Function](https://cloud.google.com/functions) is a lightweight compute solution for developers to create single-purpose, stand-alone functions that respond to Cloud events without the need to manage a server or runtime environment.
1111

1212
{% include content/beta-note.md %}
1313

src/connections/sources/catalog/libraries/website/javascript/analytics-js-2.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: Analytics.js 2.0 (Beta)
33
strat: ajs
4-
hidden: true
54
---
65
> warning "Analytics.js 2.0 is recommended for use in staging"
76
> Analytics.js 2.0 was built with backwards compatibility in mind. However, Segment recommends thorough testing in a Staging environment before you upgrade your production source.
@@ -42,6 +41,20 @@ Once enabled, after 5 minutes or less, the updated code is delivered.
4241

4342
To revert back to the previous version of Analytics.js, disable the Analytics 2.0 toggle on any source you've enabled it.
4443

44+
## Cases that require manual upgrade
45+
There are two cases where upgrading to Analytics.js 2.0 requires manual effort beyond enabling the Analytics.js 2.0 toggle.
46+
47+
### When using in-domain instrumentation CDN aliasing
48+
49+
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.
50+
51+
### When using a strict content security policy on the page
52+
53+
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:
54+
- `https://cdn.segment.com/v1/projects/<WRITE_KEY>/settings`
55+
- `https://cdn.segment.com/analytics-next/bundles/*`
56+
- `https://cdn.segment.com/next-integrations/integrations/*`
57+
4558
## Open source libraries
4659

4760
Analytics.js 2.0 includes the following open source components:

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ strat: ajs
99

1010
Analytics.js, Segment's Javascript source, makes it simple to send your data to any tool without having to learn, test or implement a new API every time.
1111

12+
> info "Analytics.js 2.0 Beta"
13+
> A new version of Analytics.js is available for use in Beta. Click [here](/docs/connections/sources/catalog/libraries/website/javascript/analytics-js-2) for more information.
14+
1215
## Getting Started
1316

1417
Read through the [Analytics.js QuickStart Guide](/docs/connections/sources/catalog/libraries/website/javascript/quickstart/) which explains how to add Analytics.js to your site in just a few minutes. Once you've installed the library, read on for the detailed API reference!

src/connections/sources/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,5 +174,7 @@ We'd love to know what other sources of data you'd like to analyze. [Contact the
174174
---
175175

176176
## Visual Tagger (Beta)
177+
> warning "Visual Tagger entering maintenance mode"
178+
> For more information, see the [Visual Tagger documentation](/docs/connections/sources/visual-tagger).
177179
178180
[Getting started with Segment Visual Tagger](/docs/connections/sources/visual-tagger)

src/connections/sources/visual-tagger.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
11
---
22
title: Visual Tagger
33
---
4+
> warning "Visual Tagger entering maintenance mode"
5+
> Visual Tagger is entering maintenance mode on **April 5th, 2021**.
6+
>
7+
> You can continue to use Visual Tagger with sources on which it's already enabled. However, the feature will no longer be available to new Segment customers and existing customers will not be able to add new Visual Tagger sources.
8+
>
9+
> Segment is committed to enabling customers to collect and deliver high quality customer data to the tools they need to run their businesses. As a CSS-based event tracking method, Visual Tagger has limitations that can prevent detailed data from being consistently collected. For code-based collection best practices, see the [Segment Spec](/docs/connections/spec).
10+
>
11+
> Going forward, support for the feature will include:
12+
> - Free, Team, and Startup customers will receive support with issues that impact multiple customers, but will not receive CSS-selector related troubleshooting
13+
> - Business customers will continue to receive full support
14+
>
15+
>
16+
> The following best practices can make your website more compatible with the feature and eliminate common issues:
17+
> - Assign unique IDs to all elements you intend to tag with Visual Tagger
18+
> - Adhere to HTML standards, such as forms inclosed in a `<form>` tag, and submitted with an `<input type="submit">` button.
419
520
Visual Tagger is a tool that enables you to collect data about what your customers are doing on your websites without having to write any code. Specifically, it helps you implement `track` events by pointing and clicking on parts of your website.
621

0 commit comments

Comments
 (0)