From 8dc8014fcbf52dd3225b536ffd82396df6817940 Mon Sep 17 00:00:00 2001 From: pwseg Date: Tue, 13 Aug 2024 13:44:52 -0400 Subject: [PATCH] libraries cleanup [LIBRARIES-1506] --- .../sources/catalog/libraries/mobile/android/index.md | 6 +++--- .../catalog/libraries/mobile/android/quickstart.md | 2 +- .../sources/catalog/libraries/mobile/android/wear.md | 8 ++++---- .../catalog/libraries/mobile/apple/implementation.md | 2 +- .../sources/catalog/libraries/mobile/apple/index.md | 2 +- .../libraries/mobile/apple/swift-destination-filters.md | 2 +- .../libraries/mobile/apple/swift-plugin-architecture.md | 2 +- .../catalog/libraries/mobile/apple/swift-samples.md | 2 +- .../catalog/libraries/mobile/apple/swift-typewriter.md | 2 +- .../sources/catalog/libraries/mobile/ios/index.md | 8 ++++---- .../sources/catalog/libraries/mobile/ios/quickstart.md | 4 ++-- .../libraries/mobile/kotlin-android/implementation.md | 2 +- .../catalog/libraries/mobile/kotlin-android/index.md | 4 ++-- .../kotlin-android/kotlin-android-destination-filters.md | 2 +- .../libraries/mobile/kotlin-android/kotlin-android-faq.md | 2 +- .../kotlin-android/kotlin-android-plugin-architecture.md | 2 +- .../mobile/kotlin-android/kotlin-android-samples.md | 2 +- .../mobile/kotlin-android/kotlin-android-typewriter.md | 2 +- .../catalog/libraries/mobile/kotlin-android/migration.md | 4 ++-- .../sources/catalog/libraries/server/kotlin/index.md | 2 +- .../catalog/libraries/website/javascript/custom-proxy.md | 2 +- src/engage/campaigns/mobile-push/index.md | 2 +- src/getting-started/02-simple-install.md | 2 +- 23 files changed, 34 insertions(+), 34 deletions(-) diff --git a/src/connections/sources/catalog/libraries/mobile/android/index.md b/src/connections/sources/catalog/libraries/mobile/android/index.md index 9a4ee04008..80bff29ade 100644 --- a/src/connections/sources/catalog/libraries/mobile/android/index.md +++ b/src/connections/sources/catalog/libraries/mobile/android/index.md @@ -1,14 +1,14 @@ --- -title: 'Analytics for Android' +title: 'Analytics-Android' strat: android repo: analytics-android support_type: maintenance id: wXNairW5xX --- - Analytics for Android makes it easier for you to send data to any tool without having to learn, test or implement a new API every time. +Analytics-Android makes it easier for you to send data to any tool without having to learn, test or implement a new API every time. -Analytics for Android only supports any Android device running API 14 (Android 4.0) and higher. This includes Amazon Fire devices. +Analytics-Android only supports any Android device running API 14 (Android 4.0) and higher. This includes Amazon Fire devices. > info "Analytics-Kotlin" > The Analytics-Kotlin library is in General Availability. You can use Analytics-Kotlin for [mobile](/docs/connections/sources/catalog/libraries/mobile/kotlin-android/) or [server](/docs/connections/sources/catalog/libraries/server/kotlin) applications. If you'd like to upgrade to Analytics-Kotlin, see the [migration guide](/docs/connections/sources/catalog/libraries/mobile/kotlin-android/migration/). Segment's future development efforts concentrate on the new Analytics-Kotlin SDK, and will only ship security updates for the Analytics-Android SDK. diff --git a/src/connections/sources/catalog/libraries/mobile/android/quickstart.md b/src/connections/sources/catalog/libraries/mobile/android/quickstart.md index 221f06e79b..0632742fa9 100644 --- a/src/connections/sources/catalog/libraries/mobile/android/quickstart.md +++ b/src/connections/sources/catalog/libraries/mobile/android/quickstart.md @@ -135,4 +135,4 @@ Once you've added a few `track` calls, **you're done!** You successfully instrum ## What's Next? -We just walked through the quickest way to get started with Segment using Analytics for Android. You might also want to check out our full [Analytics for 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. +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. diff --git a/src/connections/sources/catalog/libraries/mobile/android/wear.md b/src/connections/sources/catalog/libraries/mobile/android/wear.md index 4ece7ced87..4e8727560d 100644 --- a/src/connections/sources/catalog/libraries/mobile/android/wear.md +++ b/src/connections/sources/catalog/libraries/mobile/android/wear.md @@ -1,16 +1,16 @@ --- -title: 'Analytics for Android Wear' +title: 'Analytics-Android Wear' strat: android hidden: true --- -Analytics for Android Wear makes it simple to send your data to any tool without having to learn, test or implement a new API every time. +Analytics-Android Wear makes it simple to send your data to any tool without having to learn, test, or implement a new API every time. -All of Segment's client libraries are open-source, so you can [view Analytics for Android on GitHub](https://github.com/segmentio/analytics-android), or check out our [browser and server-side libraries](/docs/connections/sources/catalog/) too. +All of Segment's client libraries are open-source, so you can [view Analytics-Android on GitHub](https://github.com/segmentio/analytics-android), or check out our [browser and server-side libraries](/docs/connections/sources/catalog/) too. ## Getting Started -To get started with Analytics for Android Wear check out our [quickstart guide](/docs/connections/sources/catalog/libraries/mobile/android/quickstart/) which will help you install analytics tracking in your mobile app in just a few minutes. Once you've installed the SDK, read on for setting it up the wear part of your App. Note that you can only use the Android SDK v2 or later with wear, and that any Beta APIs below are subject to change. +To get started with Analytics-Android Wear check out our [quickstart guide](/docs/connections/sources/catalog/libraries/mobile/android/quickstart/) which will help you install analytics tracking in your mobile app in just a few minutes. Once you've installed the SDK, read on for setting it up the wear part of your App. Note that you can only use the Android SDK v2 or later with wear, and that any Beta APIs below are subject to change. ## Adding the Wear dependency diff --git a/src/connections/sources/catalog/libraries/mobile/apple/implementation.md b/src/connections/sources/catalog/libraries/mobile/apple/implementation.md index 5bf3b35625..bc2076965f 100644 --- a/src/connections/sources/catalog/libraries/mobile/apple/implementation.md +++ b/src/connections/sources/catalog/libraries/mobile/apple/implementation.md @@ -1,5 +1,5 @@ --- -title: Analytics for Swift Implementation Guide +title: Analytics-Swift Implementation Guide strat: swift tags: - apple diff --git a/src/connections/sources/catalog/libraries/mobile/apple/index.md b/src/connections/sources/catalog/libraries/mobile/apple/index.md index 7bcbd81ecb..b57ba18960 100644 --- a/src/connections/sources/catalog/libraries/mobile/apple/index.md +++ b/src/connections/sources/catalog/libraries/mobile/apple/index.md @@ -152,7 +152,7 @@ See Segment's [cloud-mode destinations](/docs/connections/sources/catalog/librar ## Tools and extensions -Analytics for Swift is built with extensibility in mind. Use the tools list below to improve data collection. +Analytics-Swift is built with extensibility in mind. Use the tools list below to improve data collection. - [Plugin architecture](/docs/connections/sources/catalog/libraries/mobile/swift/swift-plugin-architecture) - [Typewriter](/docs/connections/sources/catalog/libraries/mobile/swift/swift-typewriter) diff --git a/src/connections/sources/catalog/libraries/mobile/apple/swift-destination-filters.md b/src/connections/sources/catalog/libraries/mobile/apple/swift-destination-filters.md index e2e3c6e85c..777a6e54c0 100644 --- a/src/connections/sources/catalog/libraries/mobile/apple/swift-destination-filters.md +++ b/src/connections/sources/catalog/libraries/mobile/apple/swift-destination-filters.md @@ -1,5 +1,5 @@ --- -title: Analytics for Swift Destination Filters +title: Analytics-Swift Destination Filters strat: swift --- > info "" diff --git a/src/connections/sources/catalog/libraries/mobile/apple/swift-plugin-architecture.md b/src/connections/sources/catalog/libraries/mobile/apple/swift-plugin-architecture.md index d920206092..f4680fe3f3 100644 --- a/src/connections/sources/catalog/libraries/mobile/apple/swift-plugin-architecture.md +++ b/src/connections/sources/catalog/libraries/mobile/apple/swift-plugin-architecture.md @@ -1,5 +1,5 @@ --- -title: Analytics for Swift Plugin Architecture +title: Analytics-Swift Plugin Architecture strat: swift --- diff --git a/src/connections/sources/catalog/libraries/mobile/apple/swift-samples.md b/src/connections/sources/catalog/libraries/mobile/apple/swift-samples.md index 9794f3e129..b1c14be228 100644 --- a/src/connections/sources/catalog/libraries/mobile/apple/swift-samples.md +++ b/src/connections/sources/catalog/libraries/mobile/apple/swift-samples.md @@ -1,5 +1,5 @@ --- -title: Analytics for Swift Code Samples +title: Analytics-Swift Code Samples strat: swift --- diff --git a/src/connections/sources/catalog/libraries/mobile/apple/swift-typewriter.md b/src/connections/sources/catalog/libraries/mobile/apple/swift-typewriter.md index baffde1a45..770b865ef0 100644 --- a/src/connections/sources/catalog/libraries/mobile/apple/swift-typewriter.md +++ b/src/connections/sources/catalog/libraries/mobile/apple/swift-typewriter.md @@ -1,5 +1,5 @@ --- -title: Analytics for Swift Typewriter +title: Analytics-Swift Typewriter strat: swift --- [Typewriter](https://github.com/segmentio/typewriter) is a tool for generating strongly-typed Segment analytics libraries based on your pre-defined [Tracking Plan](/docs/protocols/tracking-plan) spec. diff --git a/src/connections/sources/catalog/libraries/mobile/ios/index.md b/src/connections/sources/catalog/libraries/mobile/ios/index.md index 07090f9141..594934ad2f 100644 --- a/src/connections/sources/catalog/libraries/mobile/ios/index.md +++ b/src/connections/sources/catalog/libraries/mobile/ios/index.md @@ -1,11 +1,11 @@ --- -title: Analytics for iOS +title: Analytics-iOS strat: ios repo: analytics-ios support_type: maintenance id: UBrsG9RVzw --- -With Analytics for iOS, you can send your data to analytics or marketing tool, without needing to learn, test, or implement a new API with each update or addition. +With Analytics-iOS, you can send your data to analytics or marketing tool, without needing to learn, test, or implement a new API with each update or addition.


@@ -57,7 +57,7 @@ When the app is terminated, Segment saves the queue to disk, and loads that data ### Install the SDK -The recommended way to install Analytics for iOS is using [Cocoapods](http://cocoapods.org/), since it means you can create a build with specific destinations, and because it makes it simple to install and upgrade. +The recommended way to install Analytics-iOS is using [CocoaPods](http://cocoapods.org/){:target="_blank"}, since it means you can create a build with specific destinations, and because it makes it simple to install and upgrade. First, add the `Analytics` dependency to your `Podfile`, like so: @@ -313,7 +313,7 @@ Analytics.shared().identify("a user's id", traits: ["email": "a user's email add -Analytics for iOS works on its own background thread, so it will never block the main thread for the UI or the calling thread. +Analytics-iOS works on its own background thread, so it will never block the main thread for the UI or the calling thread. Calling `- identify:` with a `userId` will write that ID to disk to be used in subsequent calls. That ID can be removed either by uninstalling the app or by calling [`reset`](#reset). diff --git a/src/connections/sources/catalog/libraries/mobile/ios/quickstart.md b/src/connections/sources/catalog/libraries/mobile/ios/quickstart.md index 73b1f131a7..f976bd00e1 100644 --- a/src/connections/sources/catalog/libraries/mobile/ios/quickstart.md +++ b/src/connections/sources/catalog/libraries/mobile/ios/quickstart.md @@ -26,7 +26,7 @@ When you create a Source in the Segment web app, it tells the Segment servers th ## Step 2: Install the SDK -Segment recommends you install Analytics for iOS by using either [Cocoapods](http://cocoapods.org/) or your Swift Package Manager. These allow you to create a build with specific bundled destinations, and they have a simplified installation and upgrading process. +Segment recommends you install Analytics-iOS by using either [CocoaPods](http://cocoapods.org/){:target="_blank"} or your Swift Package Manager. These allow you to create a build with specific bundled destinations, and they have a simplified installation and upgrading process. ### Install the SDK using Swift Package Manager @@ -234,4 +234,4 @@ Analytics.shared().flush() ## What's Next? -We just walked through the quickest way to get started with Segment using Analytics for iOS. You might also want to check out our full [Analytics for iOS reference](/docs/connections/sources/catalog/libraries/mobile/ios) 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. +We just walked through the quickest way to get started with Segment using Analytics-iOS. You might also want to check out our full [Analytics-iOS reference](/docs/connections/sources/catalog/libraries/mobile/ios) 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. diff --git a/src/connections/sources/catalog/libraries/mobile/kotlin-android/implementation.md b/src/connections/sources/catalog/libraries/mobile/kotlin-android/implementation.md index 372eff3a40..947e31d518 100644 --- a/src/connections/sources/catalog/libraries/mobile/kotlin-android/implementation.md +++ b/src/connections/sources/catalog/libraries/mobile/kotlin-android/implementation.md @@ -1,5 +1,5 @@ --- -title: Analytics for Kotlin Implementation Guide +title: Analytics-Kotlin Implementation Guide strat: kotlin-android tags: - android diff --git a/src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md b/src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md index cd961ea945..fea5f89276 100644 --- a/src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md +++ b/src/connections/sources/catalog/libraries/mobile/kotlin-android/index.md @@ -1,5 +1,5 @@ --- -title: 'Analytics for Kotlin (Android)' +title: 'Analytics-Kotlin (Android)' strat: kotlin-android redirect_from: - '/connections/sources/catalog/cloud-apps/kotlin/' @@ -190,7 +190,7 @@ Destinations are the business tools or apps that Segment forwards your data to. ## Tools and extensions -Analytics for Kotlin is built with extensibility in mind. Use the tools list below to improve data collection. +Analytics-Kotlin is built with extensibility in mind. Use the tools list below to improve data collection. - [Plugin architecture](https://segment.com/docs/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/) - [Typewriter](/docs/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-typewriter) diff --git a/src/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-destination-filters.md b/src/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-destination-filters.md index 9becb311bf..7b83cf3b75 100644 --- a/src/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-destination-filters.md +++ b/src/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-destination-filters.md @@ -1,5 +1,5 @@ --- -title: Analytics for Kotlin Destination Filters +title: Analytics-Kotlin Destination Filters strat: kotlin-android --- diff --git a/src/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-faq.md b/src/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-faq.md index 1949ab727d..8e1f3dea68 100644 --- a/src/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-faq.md +++ b/src/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-faq.md @@ -1,5 +1,5 @@ --- -title: Analytics for Kotlin FAQ +title: Analytics-Kotlin FAQ strat: kotlin-android --- diff --git a/src/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-plugin-architecture.md b/src/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-plugin-architecture.md index b93b3f3922..719cf160e9 100644 --- a/src/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-plugin-architecture.md +++ b/src/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-plugin-architecture.md @@ -1,5 +1,5 @@ --- -title: Analytics for Kotlin Plugin Architecture +title: Analytics-Kotlin Plugin Architecture strat: kotlin-android --- diff --git a/src/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-samples.md b/src/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-samples.md index 32809c4782..97870e04e9 100644 --- a/src/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-samples.md +++ b/src/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-samples.md @@ -1,5 +1,5 @@ --- -title: Analytics for Kotlin Code Samples +title: Analytics-Kotlin Code Samples strat: swift --- diff --git a/src/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-typewriter.md b/src/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-typewriter.md index f8cd366a13..43080864d0 100644 --- a/src/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-typewriter.md +++ b/src/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-typewriter.md @@ -1,5 +1,5 @@ --- -title: Analytics for Kotlin Typewriter +title: Analytics-Kotlin Typewriter strat: kotlin-android --- [Typewriter](https://github.com/segmentio/typewriter) is a tool for generating strongly-typed Segment analytics libraries based on your pre-defined [Tracking Plan](/docs/protocols/tracking-plan) spec. diff --git a/src/connections/sources/catalog/libraries/mobile/kotlin-android/migration.md b/src/connections/sources/catalog/libraries/mobile/kotlin-android/migration.md index 4b1a62e2be..a8ffb572f8 100644 --- a/src/connections/sources/catalog/libraries/mobile/kotlin-android/migration.md +++ b/src/connections/sources/catalog/libraries/mobile/kotlin-android/migration.md @@ -1,5 +1,5 @@ --- -title: Analytics for Kotlin Migration Guide +title: Analytics-Kotlin Migration Guide strat: kotlin-android tags: - android @@ -386,7 +386,7 @@ If you don't need to transform all of your Segment calls, and only want to trans ## 4. Upgrade Notes > info "You might need to call Identify as a one-off after migrating to Kotlin" -> To preserve the userId for users identified prior to your migration to Kotlin, you must make a one-off Identify call. This is due to a storage format change between the Analytics for Android and Analytics-Kotlin libraries. +> To preserve the userId for users identified prior to your migration to Kotlin, you must make a one-off Identify call. This is due to a storage format change between the Analytics-Android and Analytics-Kotlin libraries. ### 4.a) Changes to the Configuration Object diff --git a/src/connections/sources/catalog/libraries/server/kotlin/index.md b/src/connections/sources/catalog/libraries/server/kotlin/index.md index 17d1a036c4..449cd79a44 100644 --- a/src/connections/sources/catalog/libraries/server/kotlin/index.md +++ b/src/connections/sources/catalog/libraries/server/kotlin/index.md @@ -1,5 +1,5 @@ --- -title: Analytics for Kotlin (Server) +title: Analytics-Kotlin (Server) redirect_from: - '/connections/sources/catalog/cloud-apps/kotlin/' id: yMu7LRR59b diff --git a/src/connections/sources/catalog/libraries/website/javascript/custom-proxy.md b/src/connections/sources/catalog/libraries/website/javascript/custom-proxy.md index 27e024a067..4228ee3bdc 100644 --- a/src/connections/sources/catalog/libraries/website/javascript/custom-proxy.md +++ b/src/connections/sources/catalog/libraries/website/javascript/custom-proxy.md @@ -36,7 +36,7 @@ You need to set up two important parts, regardless of the CDN provider you use: > If you are using a [Regional Workspace](/docs/guides/regional-segment/#client-side-sources), please note that instead of using `api.segment.io` to proxy the Tracking API, you'll be using `events.eu1.segmentapis.com` > info "" -> Segment only has the ability to enable the proxy setting for the Web (Analytics.js) source. Details for mobile source proxies are in the [Analytics for iOS](/docs/connections/sources/catalog/libraries/mobile/ios/#proxy-https-calls) and [Analytics for Android](/docs/connections/sources/catalog/libraries/mobile/android/#proxying-http-calls) documentation. It is not currently possible to set up a proxy for server sources using the Segment UI. +> Segment only has the ability to enable the proxy setting for the Web (Analytics.js) source. Details for mobile source proxies are in the [Analytics-iOS](/docs/connections/sources/catalog/libraries/mobile/ios/#proxy-https-calls) and [Analytics-Android](/docs/connections/sources/catalog/libraries/mobile/android/#proxying-http-calls) documentation. It is not currently possible to set up a proxy for server sources using the Segment UI. ## Custom Proxy setup diff --git a/src/engage/campaigns/mobile-push/index.md b/src/engage/campaigns/mobile-push/index.md index 7bea70cce8..888283c5e3 100644 --- a/src/engage/campaigns/mobile-push/index.md +++ b/src/engage/campaigns/mobile-push/index.md @@ -209,7 +209,7 @@ The previous steps are required. For configuration options, including subscripti ### Instructions for Android -Now that you've integrated Analytics for Kotlin, follow these steps to add the Engage Plugin for Android: +Now that you've integrated Analytics-Kotlin, follow these steps to add the Engage Plugin for Android: 1. Add the following to your Gradle dependencies: diff --git a/src/getting-started/02-simple-install.md b/src/getting-started/02-simple-install.md index d6d7794f27..bb23f6898a 100644 --- a/src/getting-started/02-simple-install.md +++ b/src/getting-started/02-simple-install.md @@ -160,7 +160,7 @@ Once you add a few `track` calls, you're done with setting up Segment. You succe ### Step 1: Install the SDK
-To install Analytics for iOS, Segment recommends you to use [Cocoapods](http://cocoapods.org), because it allows you to create a build with specific bundled destinations, and because it makes it simple to install and upgrade. +To install Analytics-iOS, Segment recommends you to use [CocoaPods](http://cocoapods.org){:target="_blank"}, because it allows you to create a build with specific bundled destinations, and because it makes it simple to install and upgrade.
1) Add the `Analytics` dependency to your `Podfile` by adding the following line: