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
57 stars 2 forks source link

APP-88967 3.0 updated installation instructions #79

Closed noambartouv closed 9 months ago

noambartouv commented 9 months ago

This change is Reviewable

MikePendo commented 9 months ago

ios-integration/native-ios.md line 124 at r1 (raw file):

### Supporting SwiftUI

To support SwiftUI, the `pendoEnableSwiftUI()` modifier must be called on each of the `rootViews` in your app. See example below:

Ok somehow they got confused by the on each of the rootViews. Maybe we can change it to: `To support SwiftUI, the pendoEnableSwiftUI() modifier must be applied to your main rootView of your app. (In case of multiple rootViews for instance if you have multiple UIHostingControllers the modifier should be applied to each rootView parameter)

MikePendo commented 9 months ago

ios-integration/native-ios.md line 256 at r1 (raw file):


### SwiftUI 
- Clickable elements (e.x. Buttons / TapGestures) have a transparent background color  or that are created without a set background color (e.x. VStack or HStack) may encounter issues with identification by our SDK. To resolve this issue invoke the `pendoRecognizeClickAnalytics()` API on the `View` of this element.

Maybe lets skip the long explanation and just lets write if clickable element is not recognized as clickable apply the following modifier

MikePendo commented 9 months ago

ios-integration/native-ios.md line 260 at r1 (raw file):

- The `iOS 16 Navigation APIs` are not supported at the moment.

- The `PresentationContainer` is not supported at the moment.

I must admit I dont even remember what is PresentationContainer :) BUT WE MUST mention the Swiftui navigation (other wise it will not work )

MikePendo commented 9 months ago

ios-integration/native-ios.md line 267 at r1 (raw file):


- Codeless support for dynamic content on a page (see **) does not exist. To remedy such scenarios invoke the `screenContentChanged()` API after the dynamic content has been rendered on the screen.
    <br><br><i>\*\* 

maybe lets remove it ? (NON BLOCKING) worth discussion

udilevin commented 9 months ago

android-integration/xamarin_maui-android.md line 36 at r1 (raw file):

    In the **protected override void OnStart()** method, add the following code:

    ```c#

Think we need to add the import statement as well (we have 3 artifacts with 3 different namespaces).

udilevin commented 9 months ago

android-integration/xamarin_maui-android.md line 148 at r1 (raw file):


- For technical issues please [review open issues](https://github.com/pendo-io/pendo-mobile-sdk/issues) or [submit a new issue](https://github.com/pendo-io/pendo-mobile-sdk/issues).
- Release notes can be found [here](https://developers.pendo.io/category/mobile-sdk/).

remove the Dex issues since in Xamarin/Maui it's just a click of a button.

udilevin commented 9 months ago

ios-integration/native-ios.md line 13 at r1 (raw file):


<!-- ![Cocoapods](https://img.shields.io/cocoapods/v/Pendo) -->

Why are we combining swift ui with native? I think we should have 2 files and write at the top ... if you are looking for swiftUI instructions click here...(in native file) and if you are looking for UIKit instructions click here (in swiftui file)

udilevin commented 9 months ago

ios-integration/native-ios.md line 123 at r1 (raw file):


### Supporting SwiftUI

The phrase "on each of the rootViews " is very confusing...i was on a call with a customer that called the modifier on every view. We should clarify somehow...maybe modifier must be called on your application root view (in case your app is using multiple root views, use the modifier on each of them)...

udilevin commented 9 months ago

ios-integration/xamarin_forms-ios.md line 46 at r1 (raw file):


```c#
    ...

I think we should rename this namespace as well something like PendoXamarinForms (NB)

udilevin commented 9 months ago

ios-integration/xamarin_forms-ios.md line 143 at r1 (raw file):


## Troubleshooting

These should not happen anymore since we are not using the keychain anymore. We can remove it

udilevin commented 9 months ago

ios-integration/xamarin_maui-ios.md line 25 at r1 (raw file):

Maybe add the namespace/import as well

udilevin commented 9 months ago

ios-integration/xamarin_maui-ios.md line 121 at r1 (raw file):

        {
            if (url.Scheme.Contains("pendo"))
            {

Please add the comment about other platforms here why checking for null

udilevin commented 9 months ago

ios-integration/xamarin_forms-ios.md line 2 at r1 (raw file):

# Xamarin forms

Reminding you about the minimum requirement for Xamarin Forms with this release 5.0.0.2612. I think it should be mentioned here and in the Android as well

udilevin commented 9 months ago

migration-docs/flutter-2.x-to-3.x-migration.md line 31 at r1 (raw file):

<td align=center><b>initSDK </td>
<td>

Please note that in 3.0 PendoFlutterPlugin was renamed to PendoSDK. Please update all APIs belowe

udilevin commented 9 months ago

migration-docs/maui-2.x-to-3.x-migration.md line 20 at r1 (raw file):


<b>3.x:</b> `1.8.0`

Pendo MAUI now requires with .NET7 (2.x required .NET 6)

udilevin commented 9 months ago

migration-docs/react-native-2.x-to-3.x-migration.md line 39 at r1 (raw file):

// in the file where the NavigationContainer is created
import {withPendoRN} from 'rn-pendo-sdk'    

This is the wrong old integration: Add the following code in the method that creates the `NavigationContainer` (e.g. RootNavigator)
and returns the `NavigationContainer` wrapped using withPendoRN:

IMPORTANT: This function must be called **after** PendoSDK.setup completes

function RootNavigator(props) {
const navigationRef = useRef();
return ( <NavigationContainer
ref={navigationRef}
onStateChange={()=> {
const state = navigationRef.current.getRootState()
props.onStateChange(state);
}}
onReady ={()=>{
const state = navigationRef.current.getRootState()
props.onStateChange(state);
}}>{MainStackScreen()} )};

export default withPendoRN(RootNavigator);

In the new integration you should indicate they should remove the onReady and onStateChange

udilevin commented 9 months ago

migration-docs/xamarin-forms-2.x-to-3.x-migration.md line 25 at r1 (raw file):


<!--- new row --->

also Android V13 (API Level 33)

MikePendo commented 9 months ago

migration-docs/react-native-2.x-to-3.x-migration.md line 39 at r1 (raw file):

Previously, udilevin (Udi Levin) wrote…
This is the wrong old integration: Add the following code in the method that creates the \`NavigationContainer\` (e.g. RootNavigator) and returns the \`NavigationContainer\` wrapped using withPendoRN: #### IMPORTANT: This function must be called \*\*after\*\* PendoSDK.setup completes function RootNavigator(props) { const navigationRef = useRef(); return ( { const state = navigationRef.current.getRootState() props.onStateChange(state); }} onReady ={()=>{ const state = navigationRef.current.getRootState() props.onStateChange(state); }}>{MainStackScreen()} )}; export default withPendoRN(RootNavigator); In the new integration you should indicate they should remove the onReady and onStateChange

I dont think we should mention this integration at all

udilevin commented 9 months ago

migration-docs/xamarin-forms-2.x-to-3.x-migration.md line 25 at r1 (raw file):

Previously, noambartouv wrote…
What was the previous minimum? API Level 21? Thats quite a jump!

It’s the target not the minimum

MikePendo commented 9 months ago

ios-integration/flutter-ios.md line 16 at r3 (raw file):

    import 'package:pendo_sdk/pendo_sdk.dart';
    var pendoKey = 'YOUR_API_KEY_HERE';
    await PendoFlutterPlugin.setup(pendoKey);

I think the name was change to Pendo SDK (same apply for Android)

MikePendo commented 9 months ago

ios-integration/flutter-ios.md line 34 at r3 (raw file):

```dart
    import 'package:pendo_sdk/pendo_sdk.dart';
    await PendoFlutterPlugin.track('name', { 'firstProperty': 'firstPropertyValue', 'secondProperty': 'secondPropertyValue'});

@noambartouv @udilevin do we need to mention track events?

MikePendo commented 9 months ago

ios-integration/xamarin_forms-ios.md line 46 at r1 (raw file):

Previously, udilevin (Udi Levin) wrote…
I think we should rename this namespace as well something like PendoXamarinForms (NB)

why not PendoSDK ?

MikePendo commented 9 months ago
:lgtm:
pendo-ops commented 9 months ago

Failed pendo.io/jira-ref check. Please correct Jira references in the following commits:

1bd3b8c

pendo-ops commented 9 months ago

Failed pendo.io/jira-ref check. Please correct Jira references in the following commits:

1bd3b8c

pendo-ops commented 9 months ago

Failed pendo.io/jira-ref check. Please correct Jira references in the following commits:

1bd3b8c 757478b

pendo-ops commented 9 months ago

Failed pendo.io/jira-ref check. Please correct Jira references in the following commits:

1bd3b8c 757478b d5ca623

pendo-ops commented 9 months ago

Failed pendo.io/jira-ref check. Please correct Jira references in the following commits:

1bd3b8c 757478b d5ca623 0d38671

pendo-ops commented 9 months ago

Failed pendo.io/jira-ref check. Please correct Jira references in the following commits:

1bd3b8c 757478b d5ca623 0d38671 10fe652

pendo-ops commented 9 months ago

Failed pendo.io/jira-ref check. Please correct Jira references in the following commits:

1bd3b8c 757478b d5ca623 0d38671 10fe652 4bfe8b1

pendo-ops commented 9 months ago

Failed pendo.io/jira-ref check. Please correct Jira references in the following commits:

1bd3b8c 757478b d5ca623 0d38671 10fe652 4bfe8b1 3c2dfbd

pendo-ops commented 9 months ago

Failed pendo.io/jira-ref check. Please correct Jira references in the following commits:

1bd3b8c 757478b d5ca623 0d38671 10fe652 4bfe8b1 3c2dfbd f1951e2

pendo-ops commented 9 months ago

Failed pendo.io/jira-ref check. Please correct Jira references in the following commits:

1bd3b8c 757478b d5ca623 0d38671 10fe652 4bfe8b1 3c2dfbd f1951e2 f820c76

udilevin commented 9 months ago

android-integration/expo_rn-android.md line 3 at r14 (raw file):

# Expo using React Navigation

>[!IMPORTANT]

We should probably mention that we currently don't support codeless solution for Expo Router

udilevin commented 9 months ago

android-integration/native-android.md line 26 at r14 (raw file):


    ```shell
    dependencies {

needs to be 3.0.+

udilevin commented 9 months ago

android-integration/rn-android.md line 5 at r14 (raw file):

>[!NOTE]
>Pendo now supports Expo SDK 41-48. Follow [Expo Integration](/android-integration/expo_rn-android.md) instructions.

Like with Expo, we should probably mention here: Pendo supports RN using react-navigation 5+.
For the codeless solution to work, all the elements MUST be wrapped in react-native ui components.
As with other analytics tools, we are dependent on react-navigation screen change callbacks which means that codeless tracking analytics is available for screen components only.

udilevin commented 9 months ago

android-integration/rn-android.md line 9 at r14 (raw file):

## Step 1. Install Pendo SDK

you can use the same terms and style like expo: use one of your package managers

npm i rn-pendo-sdk
yarn add rn-pendo-sdk
udilevin commented 9 months ago

migration-docs/maui-2.x-to-3.x-migration.md line 26 at r14 (raw file):

<!--- new row --->

<tr>

Not sure how Java version applies to Xamarin or Maui...think this part can be removed (can't find anywhere we can define Java in Visual Studio

udilevin commented 9 months ago

migration-docs/maui-2.x-to-3.x-migration.md line 26 at r14 (raw file):

<!--- new row --->

<tr>

Not sure how Java version applies to Xamarin or Maui...think this part can be removed (can't find anywhere we can define Java in Visual Studio

udilevin commented 9 months ago

migration-docs/README.md line 3 at r14 (raw file):

# Migrating from version 2.x to version 3.x

>[!NOTE]

You don't have to create a new app when moving from Binding to Forms (You will need to use both iOS and Android keys in the shared plugin). They will need to update all pages.

udilevin commented 9 months ago

migration-docs/xamarin-forms-2.x-to-3.x-migration.md line 23 at r14 (raw file):


<!--- new row --->

Don't think that JAVA version is relevant to Xamarin Forms

pendo-ops commented 9 months ago

Failed pendo.io/jira-ref check. Please correct Jira references in the following commits:

1bd3b8c 757478b d5ca623 0d38671 10fe652 4bfe8b1 3c2dfbd f1951e2 f820c76 2b72ecd

pendo-ops commented 9 months ago

Failed pendo.io/jira-ref check. Please correct Jira references in the following commits:

1bd3b8c 757478b d5ca623 0d38671 10fe652 4bfe8b1 3c2dfbd f1951e2 f820c76 2b72ecd a533467

pendo-ops commented 9 months ago

Failed pendo.io/jira-ref check. Please correct Jira references in the following commits:

1bd3b8c 757478b d5ca623 0d38671 10fe652 4bfe8b1 3c2dfbd f1951e2 f820c76 2b72ecd a533467 1c78f11 cc863c8

noambartouv commented 9 months ago

[merge]

pendo-ops commented 9 months ago

The merger (noambartouv) does not have permissions to merge this Pull Request. The creator of a Pull Request cannot merge that Pull Request. Please have another team member merge it for you.

MikePendo commented 9 months ago

[merge]

pendo-ops commented 9 months ago

Some JIRA issue transitions/labels succeeded, but some didn't. Total number of issues: 1 Issues that successfully transitioned/labeled: 0 Issues that weren't transitioned/labeled: 0 Problems encountered:

Branch APP-88967-3.0-updated-installation-instructions deleted