From bd76a28367f3e5472f10570bde268965b6a198ef Mon Sep 17 00:00:00 2001 From: Seth Silesky <5115498+silesky@users.noreply.github.com> Date: Mon, 22 Apr 2024 12:50:44 -0400 Subject: [PATCH 1/4] update-out-of-date-docs --- .../website/javascript/analytics-js-2.md | 85 ------------------- .../libraries/website/javascript/index.md | 25 +----- 2 files changed, 1 insertion(+), 109 deletions(-) delete mode 100644 src/connections/sources/catalog/libraries/website/javascript/analytics-js-2.md diff --git a/src/connections/sources/catalog/libraries/website/javascript/analytics-js-2.md b/src/connections/sources/catalog/libraries/website/javascript/analytics-js-2.md deleted file mode 100644 index 7e6ece003a..0000000000 --- a/src/connections/sources/catalog/libraries/website/javascript/analytics-js-2.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: Analytics.js 2.0 (Beta) -published: false -hidden: true ---- -> warning "Analytics.js 2.0 is recommended for use in staging" -> 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. - -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. - - -## Benefits of Analytics.js 2.0 - -The Analytics.js 2.0 Beta provides two key benefits over the previous version. - -### Performance - -Analytics.js 2.0 provides a reduction in page load time, which improves overall site performance. Its package size is **~70%** smaller than the previous Analytics.js. - -> info "" -> Many factors impact page load time, including page weight, network conditions, and hosting locations. - -### Developer experience - -Analytics.js 2.0 introduces new ways for developers to augment events throughout the event timeline. This enables teams to support: - -- New privacy and consent controls before an event occurs -- Enriching events with additional customer or page context in-flight using middleware -- Collecting better metrics related to deliverability *after* a message is sent - -## Start using Analytics.js 2.0 - -Analytics.js is released as a Public Beta, on an opt-in basis, *per source*. The updated code is delivered through your existing snippet, so there's no need to update code on your site. - -To opt in: - -1. Navigate to the **Settings** tab of the JavaScript source you want to enable. -2. Enable the Analytics 2.0 toggle. - -Once enabled, after 5 minutes or less, the updated code is delivered. - -## Disable Analytics.js 2.0 - -To revert back to the previous version of Analytics.js, disable the Analytics 2.0 toggle on any source you've enabled it. - -## Cases that require manual upgrade -There are two cases where upgrading to Analytics.js 2.0 requires manual effort beyond enabling the Analytics.js 2.0 toggle. - -### When using in-domain instrumentation CDN aliasing - -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. - -### When using a strict content security policy on the page - -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: -- `https://cdn.segment.com/v1/projects//settings` -- `https://cdn.segment.com/analytics-next/bundles/*` -- `https://cdn.segment.com/next-integrations/integrations/*` - -## Open source libraries - -Analytics.js 2.0 includes the following open source components: - -**uuid v2.0.0** ([https://github.com/lukeed/uuid](https://github.com/lukeed/uuid)) -Copyright Luke Edwards <[luke.edwards05@gmail.com](mailto:luke.edwards05@gmail.com)> ([lukeed.com](https://lukeed.com/)) -License: MIT License, available here: [https://github.com/lukeed/uuid/blob/master/license](https://github.com/lukeed/uuid/blob/master/license) - - -**dset v2.0.1** ([https://github.com/lukeed/dset](https://github.com/lukeed/dset)) -Copyright (c) Luke Edwards <[luke.edwards05@gmail.com](mailto:luke.edwards05@gmail.com)> ([lukeed.com](https://lukeed.com/)) -License: MIT License, available here: [https://github.com/lukeed/dset/blob/master/license](https://github.com/lukeed/dset/blob/master/license) - -**js-cookie v2.2.1** -Copyright (c) 2018 Copyright 2018 Klaus Hartl, Fagner Brack, GitHub Contributors -  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) - -**md5 v2.3.0** ([https://github.com/pvorb/node-md5](https://github.com/pvorb/node-md5)) -Copyright (c) 2011-2012, Paul Vorbach. -Copyright (c) 2009, Jeff Mott. -License: BSD-3-Clause “New” or “Revised” License, available at: -[https://github.com/pvorb/node-md5/blob/master/LICENSE](https://github.com/pvorb/node-md5/blob/master/LICENSE) - -**unfetch v4.1.0** ([https://github.com/developit/unfetch](https://github.com/developit/unfetch)) -Copyright (c) 2017 Jason Miller -License: MIT License, available at: [https://github.com/developit/unfetch/blob/master/LICENSE.md](https://github.com/developit/unfetch/blob/master/LICENSE.md) diff --git a/src/connections/sources/catalog/libraries/website/javascript/index.md b/src/connections/sources/catalog/libraries/website/javascript/index.md index e595b9387a..a52e2edd6e 100644 --- a/src/connections/sources/catalog/libraries/website/javascript/index.md +++ b/src/connections/sources/catalog/libraries/website/javascript/index.md @@ -1006,27 +1006,4 @@ Here are some examples of using Analytics.js. Note that the examples assume Anal ## External dependencies -Analytics.js includes the following open source dependencies: - -**uuid v2.0.0** ([https://github.com/lukeed/uuid](https://github.com/lukeed/uuid)) -Copyright Luke Edwards <[luke.edwards05@gmail.com](mailto:luke.edwards05@gmail.com)> ([lukeed.com](https://lukeed.com/)) -License: MIT License, available here: [https://github.com/lukeed/uuid/blob/master/license](https://github.com/lukeed/uuid/blob/master/license) - - -**dset v2.0.1** ([https://github.com/lukeed/dset](https://github.com/lukeed/dset)) -Copyright (c) Luke Edwards <[luke.edwards05@gmail.com](mailto:luke.edwards05@gmail.com)> ([lukeed.com](https://lukeed.com/)) -License: MIT License, available here: [https://github.com/lukeed/dset/blob/master/license](https://github.com/lukeed/dset/blob/master/license) - -**js-cookie v2.2.1** -Copyright (c) 2018 Copyright 2018 Klaus Hartl, Fagner Brack, GitHub Contributors -  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) - -**md5 v2.3.0** ([https://github.com/pvorb/node-md5](https://github.com/pvorb/node-md5)) -Copyright (c) 2011-2012, Paul Vorbach. -Copyright (c) 2009, Jeff Mott. -License: BSD-3-Clause “New” or “Revised” License, available at: -[https://github.com/pvorb/node-md5/blob/master/LICENSE](https://github.com/pvorb/node-md5/blob/master/LICENSE) - -**unfetch v4.1.0** ([https://github.com/developit/unfetch](https://github.com/developit/unfetch)) -Copyright (c) 2017 Jason Miller -License: MIT License, available at: [https://github.com/developit/unfetch/blob/master/LICENSE.md](https://github.com/developit/unfetch/blob/master/LICENSE.md) +The production dependencies can be found [listed the **dependencies** key](https://github.com/segmentio/analytics-next/blob/master/packages/browser/package.json){:target="_blank”}. From a7a73ef20ee5d8a39328487aa99ce96ef6e582c5 Mon Sep 17 00:00:00 2001 From: Seth Silesky <5115498+silesky@users.noreply.github.com> Date: Mon, 22 Apr 2024 12:51:39 -0400 Subject: [PATCH 2/4] wip --- .../sources/catalog/libraries/website/javascript/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/libraries/website/javascript/index.md b/src/connections/sources/catalog/libraries/website/javascript/index.md index a52e2edd6e..277c0f4423 100644 --- a/src/connections/sources/catalog/libraries/website/javascript/index.md +++ b/src/connections/sources/catalog/libraries/website/javascript/index.md @@ -1006,4 +1006,4 @@ Here are some examples of using Analytics.js. Note that the examples assume Anal ## External dependencies -The production dependencies can be found [listed the **dependencies** key](https://github.com/segmentio/analytics-next/blob/master/packages/browser/package.json){:target="_blank”}. +The production dependencies can be found [listed under the **dependencies** key](https://github.com/segmentio/analytics-next/blob/master/packages/browser/package.json){:target="_blank”}. From 626c198ebfb8967abb2570a70de7010ee46a0aa4 Mon Sep 17 00:00:00 2001 From: Seth Silesky <5115498+silesky@users.noreply.github.com> Date: Mon, 22 Apr 2024 12:52:01 -0400 Subject: [PATCH 3/4] wip --- .../sources/catalog/libraries/website/javascript/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/libraries/website/javascript/index.md b/src/connections/sources/catalog/libraries/website/javascript/index.md index 277c0f4423..4fb667e33d 100644 --- a/src/connections/sources/catalog/libraries/website/javascript/index.md +++ b/src/connections/sources/catalog/libraries/website/javascript/index.md @@ -1006,4 +1006,4 @@ Here are some examples of using Analytics.js. Note that the examples assume Anal ## External dependencies -The production dependencies can be found [listed under the **dependencies** key](https://github.com/segmentio/analytics-next/blob/master/packages/browser/package.json){:target="_blank”}. +Analytics.js production dependencies can be found [listed under the **dependencies** key](https://github.com/segmentio/analytics-next/blob/master/packages/browser/package.json){:target="_blank”}. From 2cc9fbd00782110dd0719d383be3ca18bab9857f Mon Sep 17 00:00:00 2001 From: Seth Silesky <5115498+silesky@users.noreply.github.com> Date: Mon, 22 Apr 2024 15:29:27 -0400 Subject: [PATCH 4/4] Update src/connections/sources/catalog/libraries/website/javascript/index.md Co-authored-by: forstisabella <92472883+forstisabella@users.noreply.github.com> --- .../sources/catalog/libraries/website/javascript/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/libraries/website/javascript/index.md b/src/connections/sources/catalog/libraries/website/javascript/index.md index 4fb667e33d..20d11a7320 100644 --- a/src/connections/sources/catalog/libraries/website/javascript/index.md +++ b/src/connections/sources/catalog/libraries/website/javascript/index.md @@ -1006,4 +1006,4 @@ Here are some examples of using Analytics.js. Note that the examples assume Anal ## External dependencies -Analytics.js production dependencies can be found [listed under the **dependencies** key](https://github.com/segmentio/analytics-next/blob/master/packages/browser/package.json){:target="_blank”}. +Analytics.js production dependencies are [listed under the **dependencies** key](https://github.com/segmentio/analytics-next/blob/master/packages/browser/package.json){:target="_blank”}.