Flutter SDK [DOC-811] #6088

stayseesong · 2024-02-16T23:49:54Z

Proposed changes

Merge timing

Related issues (optional)

netlify · 2024-02-16T23:54:31Z

✅ Deploy Preview for segment-docs ready!

Name	Link
🔨 Latest commit	`661fe8f`
🔍 Latest deploy log	https://app.netlify.com/sites/segment-docs/deploys/65dce64333348d00081597ee
😎 Deploy Preview	https://deploy-preview-6088--segment-docs.netlify.app/connections/sources/catalog/libraries/mobile/flutter
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

oscb

Looks great! I have a few suggestions as we've changed the package name for the release.

src/connections/sources/catalog/libraries/mobile/flutter/index.md

oscb · 2024-02-20T18:45:45Z

src/connections/sources/catalog/libraries/mobile/flutter/index.md

+
+See the [example app](https://github.com/segmentio/analytics_flutter/blob/main/example/README.md){:target="_blank"} to check a full test app of how to integrate Analytics-Flutter into your own Flutter app.
+


It might be worth adding a section here for people upgrading from pilot as there's a few steps they have to do. Not sure if it should be at the end or as part of the install instructions. Here's what I wrote in the readme:

Suggested change

## Upgrading from Pilot

Since pilot phase we have renamed the package of this library from `analytics` to `segment_analytics`. Some changes have to be applied after upgrading to the v1 package:

In your `pubspec.yaml` remove the `analytics` package and use `segment_analytics` instead.

```diff

- analytics:

- git:

- url: https://github.com/segmentio/analytics_flutter

- ref: main

- path: packages/core

+ segment_analytics: ^1.0.1

```

In your dart files change the imports from `package:analytics` to `package:segment_analytics`:

```diff

- import 'package:analytics/client.dart';

+ import 'package:segment_analytics/client.dart';

```

mgutten · 2024-02-20T22:20:28Z

src/connections/sources/catalog/libraries/mobile/flutter/index.md

+> The Analytics-Flutter library is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. For more information, see the [Analytics-Flutter GitHub repository](https://github.com/segmentio/analytics_flutter){:target="_blank"}. 
+
+Analytics-Flutter enables you to seamlessly add Segment analytics to your Flutter1 app.


Stupid question: is it actually "Flutter1" or was that a typo? 😅

oops sorry, that's a typo

mgutten · 2024-02-20T22:23:59Z

src/connections/sources/catalog/libraries/mobile/flutter/index.md

+
+## Utility methods
+The Analytics-Flutter utility methods help you work with plugins fro the analytics timeline. They include:


Small typo: "fro" -> "from"

mgutten · 2024-02-20T22:28:54Z

src/connections/sources/catalog/libraries/mobile/flutter/index.md

+## Automatic screen tracking
+
+To set up automatic screen tracking, you need to add the analytics navigator observer to your app's navigator observers. For example, if you're using the `MaterialApp` class, add the following:


I was confused by what Automatic Screen Tracking was until I read more in the Github repo - maybe we should include this context in these docs also:

Sending a screen() event with each navigation action will get tiresome, so you may want to track navigation globally.

Co-authored-by: Oscar Bazaldua <511911+oscb@users.noreply.github.com>

…DOC-811

stayseesong · 2024-02-26T19:30:28Z

@mgutten @oscb I incorporated your changes/ suggestions. Lmk if there's anything else that needs to be added/changed

oscb

lgtm! I'm glad you made a pass, didn't realize our readme had so many little typos! 😅

pwseg

Mostly minor stuff.

src/connections/sources/catalog/libraries/mobile/flutter/index.md

Co-authored-by: pwseg <86626706+pwseg@users.noreply.github.com>

github-actions · 2024-02-29T18:14:28Z

Thank you for your contribution! Your pull request is merged, but may take a day or two to appear on the site.

stayseesong added 2 commits February 14, 2024 09:57

edits

68c349b

Analytics-Flutter [netlify-build]

64395ed

stayseesong requested a review from a team as a code owner February 16, 2024 23:49

stayseesong requested review from pwseg and removed request for a team February 16, 2024 23:49

stayseesong added the new-integration Added a new source or destination label Feb 16, 2024

stayseesong requested review from oscb and mgutten February 16, 2024 23:51

oscb suggested changes Feb 20, 2024

View reviewed changes

mgutten reviewed Feb 20, 2024

View reviewed changes

stayseesong and others added 4 commits February 21, 2024 15:47

Apply suggestions from code review

129d175

Co-authored-by: Oscar Bazaldua <511911+oscb@users.noreply.github.com>

edits

6808401

Merge branch 'DOC-811' of ssh://github.com/segmentio/segment-docs into …

483c267

…DOC-811

edits [netlify-build]

661fe8f

stayseesong requested review from mgutten and oscb February 26, 2024 19:29

oscb approved these changes Feb 26, 2024

View reviewed changes

pwseg approved these changes Feb 27, 2024

View reviewed changes

Apply suggestions from code review

7235133

Co-authored-by: pwseg <86626706+pwseg@users.noreply.github.com>

stayseesong merged commit fbdce5d into develop Feb 29, 2024
3 checks passed

stayseesong deleted the DOC-811 branch February 29, 2024 18:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Flutter SDK [DOC-811] #6088

Flutter SDK [DOC-811] #6088

stayseesong commented Feb 16, 2024

netlify bot commented Feb 16, 2024 •

edited

Loading

oscb left a comment

oscb Feb 20, 2024

mgutten Feb 20, 2024

stayseesong Feb 21, 2024

mgutten Feb 20, 2024 •

edited

Loading

mgutten Feb 20, 2024

stayseesong commented Feb 26, 2024

oscb left a comment

pwseg left a comment

github-actions bot commented Feb 29, 2024


		See the [example app](https://github.com/segmentio/analytics_flutter/blob/main/example/README.md){:target="_blank"} to check a full test app of how to integrate Analytics-Flutter into your own Flutter app.

+## Upgrading from Pilot
+	Since pilot phase we have renamed the package of this library from `analytics` to `segment_analytics`. Some changes have to be applied after upgrading to the v1 package:
+	In your `pubspec.yaml` remove the `analytics` package and use `segment_analytics` instead.
+	```diff
+	-   analytics:
+	-     git:
+	-       url: https://github.com/segmentio/analytics_flutter
+	-       ref: main
+	-       path: packages/core
+	+   segment_analytics: ^1.0.1
+	```
+	In your dart files change the imports from `package:analytics` to `package:segment_analytics`:
+	```diff
+	- import 'package:analytics/client.dart';
+	+ import 'package:segment_analytics/client.dart';
+	```

		> The Analytics-Flutter library is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. For more information, see the [Analytics-Flutter GitHub repository](https://github.com/segmentio/analytics_flutter){:target="_blank"}.

		Analytics-Flutter enables you to seamlessly add Segment analytics to your Flutter1 app.


		## Utility methods
		The Analytics-Flutter utility methods help you work with plugins fro the analytics timeline. They include:

		## Automatic screen tracking

		To set up automatic screen tracking, you need to add the analytics navigator observer to your app's navigator observers. For example, if you're using the `MaterialApp` class, add the following:

Flutter SDK [DOC-811] #6088

Flutter SDK [DOC-811] #6088

Conversation

stayseesong commented Feb 16, 2024

Proposed changes

Merge timing

Related issues (optional)

netlify bot commented Feb 16, 2024 • edited Loading

✅ Deploy Preview for segment-docs ready!

oscb left a comment

Choose a reason for hiding this comment

oscb Feb 20, 2024

Choose a reason for hiding this comment

mgutten Feb 20, 2024

Choose a reason for hiding this comment

stayseesong Feb 21, 2024

Choose a reason for hiding this comment

mgutten Feb 20, 2024 • edited Loading

Choose a reason for hiding this comment

mgutten Feb 20, 2024

Choose a reason for hiding this comment

stayseesong commented Feb 26, 2024

oscb left a comment

Choose a reason for hiding this comment

pwseg left a comment

Choose a reason for hiding this comment

github-actions bot commented Feb 29, 2024

netlify bot commented Feb 16, 2024 •

edited

Loading

mgutten Feb 20, 2024 •

edited

Loading