pendo-io / pendo-mobile-sdk

Pendo captures product usage data, gathers user feedback, and lets you communicate in-app to onboard, educate, and guide users to value
https://www.pendo.io
Other
58 stars 2 forks source link

APP-104740_flutter_codeless_docs #157

Closed MikePendo closed 3 months ago

MikePendo commented 3 months ago

This change is Reviewable

MikePendo commented 3 months ago

android/pnddocs/flutter-android.md line 4 at r1 (raw file):

Previously, naorlevi (pippoTLV) wrote…
low-code instead of codeless

Done.

MikePendo commented 3 months ago

ios/pnddocs/flutter-ios.md line 4 at r1 (raw file):

Previously, naorlevi (pippoTLV) wrote…
Flutter low-code solution is currently in OPEN BETA

Done.

MikePendo commented 3 months ago

other/flutter-notes-known-issues-limitations.md line 7 at r1 (raw file):

Previously, naorlevi (pippoTLV) wrote…
Elements

Done.

MikePendo commented 3 months ago

other/flutter-notes-known-issues-limitations.md line 8 at r1 (raw file):

Previously, naorlevi (pippoTLV) wrote…
touchDown and touchUp

Done.

MikePendo commented 3 months ago

other/flutter-notes-known-issues-limitations.md line 13 at r1 (raw file):

Previously, naorlevi (pippoTLV) wrote…
e.g Drag and Swipe gestures

Done.

naorlevi commented 3 months ago

other/flutter-notes-known-issues-limitations.md line 7 at r1 (raw file):

Previously, udilevin (Udi Levin) wrote…
what are elements in Pendo? Should probably be features

perhaps Widgets?

MaximShnirman commented 3 months ago

other/flutter-notes-known-issues-limitations.md line 3 at r2 (raw file):


## Navigation Libraries

I think we should have a dedicated place to put the native flutter integration in, like the calls to set up, start sessions, etc. under that, id expect to have more framework specific integration

MaximShnirman commented 3 months ago

other/flutter-notes-known-issues-limitations.md line 2 at r2 (raw file):

we are missing go router nested branching integration (shell support)

  1. need to add PendoNavigationObserver in each branch
  2. need to add PendoNavigationObserver under the go router config
  3. need to create a 'static NestedBranchesObserver nestedBranchesObserver = NestedBranchesObserver();'
  4. under the build method call it like so 'nestedBranchesObserver.addListener(_router);' (where _router is the GoRouter one)
  5. in case this was added to a stateful widget, call the following: 'pendoNestedBranchesObserver.removeListener(_router);' under the dispose method

example can be found in our host app, under: 'shell_route_navigation.dart' file and also documentation of this is here: https://pendo-io.atlassian.net/browse/APP-100887

DavidPendo commented 3 months ago

android/pnddocs/flutter-android.md line 36 at r2 (raw file):

Previously, MaximShnirman (Maxim Shnirman) wrote…
@DavidPendo was this changed?

No... The most important here is minSdkVersion, meaning the hosting app can't have the lowest version that Pendo requires.

The compileSdkVersion is irrelevant here because it is about the Android API you can access during development. So I would remove it @MikePendo

DavidPendo commented 3 months ago

android/pnddocs/flutter-android.md line 36 at r2 (raw file):

Previously, DavidPendo wrote…
No... The most important here is **minSdkVersion**, meaning the hosting app can't have the lowest version that Pendo requires. The **compileSdkVersion** is irrelevant here because it is about the Android API you can access during development. So I would remove it @MikePendo

Or you can leave it as it does not affect anything

DavidPendo commented 3 months ago

android/pnddocs/flutter-android.md line 64 at r2 (raw file):

>The `API Key` can be found in your Pendo Subscription Settings in App Details.

1. Add the following code in the `initState` method:

Is it worth mentioning that - you should perform the setup call as early as possible?

Just the Add the following code in the initState method is to abstract, like where the customer should add it?

MikePendo commented 3 months ago
Previously, noambartouv wrote…
Do we need to update anything in the flutter API docs? The setup method? https://github.com/pendo-io/pendo-mobile-sdk/blob/APP-104740_flutter_codeless_docs/api-documentation/flutter-apis.md

I think no, I would like to consider classes as PendoObservebale and ActionListener NOT as new API

MikePendo commented 3 months ago

android/pnddocs/flutter-android.md line 8 at r2 (raw file):

Previously, noambartouv wrote…
the >= an < symbols are confusing. Please use words and remove the quotes (styling should remain consistent across the entire github)

That's how flutter use it and that is what written in the pubspec yaml and I believe should be easy to read for flutter devs. looking at the other repos I dont see them mention it at all @naorlevi your call

MikePendo commented 3 months ago

android/pnddocs/flutter-android.md line 9 at r2 (raw file):

Previously, noambartouv wrote…
what does 'SDK' mean? Is there no dart requirement anymore?

Dart come together with the SDK. (in most cases )

MikePendo commented 3 months ago

android/pnddocs/flutter-android.md line 36 at r2 (raw file):

Previously, DavidPendo wrote…
Or you can leave it as it does not affect anything

removed

MikePendo commented 3 months ago

android/pnddocs/flutter-android.md line 59 at r2 (raw file):

Previously, MaximShnirman (Maxim Shnirman) wrote…
why is this step part of the specific Android integration?

@DavidPendo maybe you can answer (I took it from the last Flutter integration)

MikePendo commented 3 months ago

android/pnddocs/flutter-android.md line 64 at r2 (raw file):

Previously, noambartouv wrote…
1. this is a change from existing customers - will existing customers upgrading encounter issues because setup is expected in a different location now? 2. Do we need to mention in which file the initState method can be found? Is it obvious to all flutter devs?

1.

  1. explained it in better words
MikePendo commented 3 months ago

android/pnddocs/flutter-android.md line 95 at r2 (raw file):

Previously, noambartouv wrote…
+1

added though dont think its necessary

MikePendo commented 3 months ago

android/pnddocs/flutter-android.md line 95 at r2 (raw file):

Previously, noambartouv wrote…
Let's combine the two lines before the code block. It looks weird as 1 line

I dont know it becomes to long

MikePendo commented 3 months ago

android/pnddocs/flutter-android.md line 98 at r2 (raw file):

Previously, noambartouv wrote…
Alternative text: Observes the MaterialApp/CupertinoApp main Navigator

changed

MikePendo commented 3 months ago

android/pnddocs/flutter-android.md line 105 at r2 (raw file):

Previously, noambartouv wrote…
Alternative text: Observes the widget Navigator

changed

MikePendo commented 3 months ago

android/pnddocs/flutter-android.md line 112 at r2 (raw file):

Previously, noambartouv wrote…
Alternative text: Observes the GoRouter 3rd party routing

Changed

MikePendo commented 3 months ago

android/pnddocs/flutter-android.md line 140 at r2 (raw file):

Previously, noambartouv wrote…
This looks weird as a tip and after it a code block. In general I don't see we suggest track events in other integrations. I suggest to move its own Optional step if we want to keep it. Alternative text: Use track events to programmatically notify Pendo of custom events of interest: Link: let's link 'track events' to the resource center article: https://support.pendo.io/hc/en-us/articles/360032294151-Track-Events

@naorlevi your call I think its fine @noambartouv added link

MikePendo commented 3 months ago

android/pnddocs/flutter-android.md line 179 at r2 (raw file):

Previously, noambartouv wrote…
Alternative text: Flutter Open Beta support and know issues

I dont know @naorlevi

naorlevi commented 3 months ago

android/pnddocs/flutter-android.md line 8 at r2 (raw file):

Previously, MikePendo (Michael Rozenblat) wrote…
That's how flutter use it and that is what written in the pubspec yaml and I believe should be easy to read for flutter devs. looking at the other repos I dont see them mention it at all @naorlevi your call

That seems to be the standard then, leave it as is.

naorlevi commented 3 months ago

android/pnddocs/flutter-android.md line 140 at r2 (raw file):

Previously, MikePendo (Michael Rozenblat) wrote…
@naorlevi your call I think its fine @noambartouv added link

ok. let's go with @noambartouv suggestion

MikePendo commented 3 months ago

android/pnddocs/flutter-android.md line 64 at r2 (raw file):

Previously, MikePendo (Michael Rozenblat) wrote…
1. 2. explained it in better words
  1. No
naorlevi commented 3 months ago

android/pnddocs/flutter-android.md line 179 at r2 (raw file):

Previously, MikePendo (Michael Rozenblat) wrote…
I dont know @naorlevi

No need in my opinion. We wrote it's beta before

MikePendo commented 3 months ago

other/flutter-notes-known-issues-limitations.md line 9 at r2 (raw file):

Previously, noambartouv wrote…
I think let's turn this into a list of widgets to a bullet list

it becomes very long in that case

MikePendo commented 3 months ago

other/flutter-notes-known-issues-limitations.md line 8 at r2 (raw file):

Previously, noambartouv wrote…
Alternative text: Our implementation supports ...

changing though I dont see values in the change

MikePendo commented 3 months ago

other/flutter-notes-known-issues-limitations.md line 7 at r1 (raw file):

Previously, naorlevi (pippoTLV) wrote…
perhaps Widgets?

Done.

MikePendo commented 3 months ago

other/flutter-notes-known-issues-limitations.md line 3 at r2 (raw file):

Previously, MaximShnirman (Maxim Shnirman) wrote…
I think we should have a dedicated place to put the native flutter integration in, like the calls to set up, start sessions, etc. under that, id expect to have more framework specific integration

what? I am not sure I follow

MikePendo commented 3 months ago

other/flutter-notes-known-issues-limitations.md line 16 at r2 (raw file):

Previously, noambartouv wrote…
Let's remove the first sentence - it doesn't add anything.

why? it gives more context about what the meaning of static vs dynamic?

MikePendo commented 3 months ago

other/flutter-notes-known-issues-limitations.md line 13 at r2 (raw file):

Previously, noambartouv wrote…
Add a
at the end of the previous line (this sentence currently continues the previous line)

Done

MikePendo commented 3 months ago

other/flutter-notes-known-issues-limitations.md line 24 at r2 (raw file):

Previously, noambartouv wrote…
What does that mean? How is the customer effected? BE will not send / drop stuff?

@naorlevi please suggest

DavidPendo commented 3 months ago

android/pnddocs/flutter-android.md line 32 at r3 (raw file):


- Minimum and compile SDK Version:  
If applicable, set your app to be compiled with **compileSdkVersion 33** or higher and **minSdkVersion 21** or higher:

@MikePendo here please change it to

If applicable, set your app to be **minSdkVersion 21** or higher:
DavidPendo commented 3 months ago

android/pnddocs/flutter-android.md line 59 at r2 (raw file):

Previously, MikePendo (Michael Rozenblat) wrote…
@DavidPendo maybe you can answer (I took it from the last Flutter integration)

@MaximShnirman, this approach was chosen for all our framework integration documents for some reason. Maybe there is a better way to guide through installation instructions using the common part and then specify the platform specifics. I don't know if for know is better to keep it align with all the rest or do this change for Flutter only

MikePendo commented 3 months ago

android/pnddocs/flutter-android.md line 32 at r3 (raw file):

Previously, DavidPendo wrote…
@MikePendo here please change it to ``` If applicable, set your app to be **minSdkVersion 21** or higher: ```

Done

MikePendo commented 3 months ago

android/pnddocs/flutter-android.md line 64 at r2 (raw file):

Previously, DavidPendo wrote…
Is it worth mentioning that - you should perform the **setup** call as early as possible? Just the **Add the following code in the `initState` method** is to abstract, like where the customer should add it?

Done

MikePendo commented 3 months ago

android/pnddocs/flutter-android.md line 121 at r2 (raw file):

Previously, noambartouv wrote…
Let's combine the two lines before the code block. It looks weird as 1 line typo: Add a click listener / add click listeners

Didnt combine I think its fine

MikePendo commented 3 months ago

android/pnddocs/flutter-android.md line 140 at r2 (raw file):

Previously, naorlevi (pippoTLV) wrote…
ok. let's go with @noambartouv suggestion

Done

MaximShnirman commented 3 months ago

other/flutter-code-samples.md line 47 at r5 (raw file):


    @override
    void dispose() {

the dispose section exists only for StatefullWidgets. i think this should be mentioned as the customers will get confused

naorlevi commented 3 months ago

other/flutter-notes-known-issues-limitations.md line 24 at r2 (raw file):

Previously, MikePendo (Michael Rozenblat) wrote…
@naorlevi please suggest

They will not be able to tag pages and features

MaximShnirman commented 3 months ago

other/flutter-code-samples.md line 3 at r9 (raw file):


The following example demonstrates Go_router integration with nested branches 

this file should appear in the main documentation as well https://github.com/pendo-io/pendo-mobile-sdk/tree/APP-104740_flutter_codeless_docs

udilevin commented 3 months ago

:lgtm:[merge]

pendo-ops commented 3 months ago

All JIRA issue transitioned/labeled.

Branch APP-104740_flutter_codeless_docs deleted