Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

SDK-5238 Delayed init android docs #8397

Open
wants to merge 13 commits into
base: develop
Choose a base branch
from
Open

SDK-5238 Delayed init android docs #8397

wants to merge 13 commits into from

Conversation

chshapiro
Copy link
Contributor

Why are you making this change? (required)

Documentation for future delayed init feature on Android

Related PRs, issues, or features (optional)

(https://jira.braze.com/browse/SDK-5238)

Feature release date (optional)

  • unknown

Contributor checklist

  • I confirm that my PR meets the following:
    • I signed the Contribution License Agreement (CLA).
    • My style and voice follows the Braze Style Guide.
    • My content contains correct spelling and grammar.
    • All links are working correctly.
    • If I renamed or moved a file or directory, I set up URL redirects for each file.
    • If I updated or replaced an image, I did not remove the original image file from the repository. (For more information, see Updating an image).
    • If my PR is related to a paid SKU, third party, SMS, AI, or privacy, I have received written approval from Braze Legal.

Submitting for review

If your PR meets the above requirements, select Ready for review, then add a reviewer:

  • Non-Braze contributors: Add braze-inc/docs-team as the reviewer.
  • Braze employees: Have any relevant subject matter experts (like engineers or product managers) review your work first, then add the tech writer assigned to your specific vertical. If you're not sure which tech writer to add, you can add braze-inc/docs-team instead.

Thanks for contributing! We look forward to reading your work.

@chshapiro chshapiro added the status: do not merge Could mean research before "in progress" status, or do not merge yet. label Nov 12, 2024
@cla-bot cla-bot bot added the cla-signed label Nov 12, 2024
@chshapiro chshapiro requested review from bryanlogan, vanessaland and a team November 12, 2024 16:27
@vercel Vercel
Copy link

vercel bot commented Nov 12, 2024

@chshapiro is attempting to deploy a commit to the Braze team on Vercel, but is not a member of this team. To resolve this issue, you can:

  • Make your repository public. Collaboration is free for open source and public repositories.
  • Add @chshapiro as a member. A Pro subscription is required to access Vercel's collaborative features.
    • If you're the owner of the team, click here and add @chshapiro as a member.
    • If you're the user who initiated this build request, click here to request access.
    • If you're already a member of the Braze team, make sure that your Vercel account is connected to your GitHub account.

To read more about collaboration on Vercel, click here.

@chshapiro chshapiro removed the request for review from a team November 12, 2024 16:34
@josh-mccrowell-braze
Copy link
Collaborator

Assigning @internetisaiah to this PR to shepherd. Just noting that he is traveling at a conference this week. Since the due date on this is not specified, I'm hoping this is okay. If something changes, please ping me!

bryanlogan
bryanlogan requested changes Nov 12, 2024
View reviewed changes
...loper_guide/platform_integration_guides/android/advanced_use_cases/delayed_initialization.md Outdated Show resolved Hide resolved
...loper_guide/platform_integration_guides/android/advanced_use_cases/delayed_initialization.md Outdated Show resolved Hide resolved
...loper_guide/platform_integration_guides/android/advanced_use_cases/delayed_initialization.md Outdated Show resolved Hide resolved
...loper_guide/platform_integration_guides/android/advanced_use_cases/delayed_initialization.md Outdated Show resolved Hide resolved
...loper_guide/platform_integration_guides/android/advanced_use_cases/delayed_initialization.md Outdated Show resolved Hide resolved
...loper_guide/platform_integration_guides/android/advanced_use_cases/delayed_initialization.md Outdated Show resolved Hide resolved
...loper_guide/platform_integration_guides/android/advanced_use_cases/delayed_initialization.md Outdated Show resolved Hide resolved
...loper_guide/platform_integration_guides/android/advanced_use_cases/delayed_initialization.md Outdated Show resolved Hide resolved
...loper_guide/platform_integration_guides/android/advanced_use_cases/delayed_initialization.md Outdated Show resolved Hide resolved
...loper_guide/platform_integration_guides/android/initial_sdk_setup/android_sdk_integration.md Outdated Show resolved Hide resolved
bryanlogan
bryanlogan reviewed Nov 12, 2024
View reviewed changes
...loper_guide/platform_integration_guides/android/advanced_use_cases/delayed_initialization.md Outdated
While delayed initialization is enabled, all network connections to be canceled, and the Braze SDK will not pass any data to Braze servers.

{% alert important %}
Delayed initialization is available starting in Android SDK version xxxx.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm just going to comment here to make sure we don't forget to add the Android version once we have it.

chshapiro
chshapiro commented Nov 12, 2024
View reviewed changes
...loper_guide/platform_integration_guides/android/advanced_use_cases/delayed_initialization.md Outdated
<string name="com_braze_delayed_initialization_analytics_behavior">"QUEUE"</string>
```

Additionaly, the push analytics behavior can be set during runtime in the [`Braze.enableDelayedInitialization()`](set link after release) method by using one of the following code snippets:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

commenting to remember to add link after release

chshapiro
chshapiro commented Nov 12, 2024
View reviewed changes
...loper_guide/platform_integration_guides/android/advanced_use_cases/delayed_initialization.md Outdated

## Initializing After Delay

To initialize the SDK once the delay period is over, use the [`Braze.disableDelayedInitialization()`](set link after release) method:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

commenting to remember to link after relase

@chshapiro chshapiro requested a review from bryanlogan November 12, 2024 20:41
vanessaland
vanessaland approved these changes Nov 14, 2024
View reviewed changes
Copy link
Contributor

@vanessaland vanessaland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some suggestions to help with the reader flow, but otherwise doc LGTM!

...loper_guide/platform_integration_guides/android/advanced_use_cases/delayed_initialization.md Outdated Show resolved Hide resolved
...loper_guide/platform_integration_guides/android/advanced_use_cases/delayed_initialization.md Outdated Show resolved Hide resolved
...loper_guide/platform_integration_guides/android/advanced_use_cases/delayed_initialization.md Outdated
Delayed initialization is available starting in Android SDK version xxxx.
{% endalert %}

## Enabling Delayed Initialization
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What are your thoughts on adding numbers to the subtitles? For example, Step 1: Enabling Delayed Initialization or 1. Enabling Delayed Initialization

I think this would help the reader understand that the steps flow together. This is also helpful for parity, because the Swift Docs uses numbered Steps)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not really steps where they all need to be done. Each section is a different part of the feature. If there's numbers, I think users will think they need to do all the steps.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh right that's true! Since there are cases where a user may never init afterwards, etc. I agree with having no numbers then

Copy link
Contributor

@internetisaiah internetisaiah Nov 21, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Follow-up: are certain steps required before completing other steps? i.e., maybe doing something like this:

# Title

Description

## Enabling delayed initialization

...

## Optional configurations

### Push analytics

...

### Initialization after delay

...

(or something similar?)

...loper_guide/platform_integration_guides/android/advanced_use_cases/delayed_initialization.md Outdated Show resolved Hide resolved
internetisaiah
internetisaiah reviewed Nov 21, 2024
View reviewed changes
...loper_guide/platform_integration_guides/android/advanced_use_cases/delayed_initialization.md Outdated

When delayed initialization is enabled, you have the option to queue or drop push analytics. If push analytics are queued, these events will be logged once delayed initialization is disabled.

By default, push analytics are queued when delayed initialization is enabled. In order to drop push analytics, update your `braze.xml` file to include `com_braze_delayed_initialization_analytics_behavior` as follows:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To me, this line:

By default, push analytics are queued when delayed initialization is enabled.

seems to conflict with the line above it:

If push analytics are queued, these events will be logged once delayed initialization is disabled.

could i get some clarity here when you get the chance @chshapiro ? thanks!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*Note: this has been removed it in the current commit. Please be sure to double-check my changes to ensure I'm still representing the original idea properly 👍🏽

internetisaiah
internetisaiah requested changes Nov 21, 2024
View reviewed changes
Copy link
Contributor

@internetisaiah internetisaiah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM other than the missing version number and the links to the new method. Once we add those this can be merged 🫡

@chshapiro
Copy link
Contributor Author

Thanks! This feature won't be released for a few more weeks - once it is, I will update the version numbers and links

@josh-mccrowell-braze
Copy link
Collaborator

Hey @chshapiro : Just checking in to see if you knew the exact timeline for this feature release yet. Cheers!

@chshapiro
Copy link
Contributor Author

Hey @josh-mccrowell-braze we probably won't be releasing this until the new year. Will update here when we're ready to make this live

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@internetisaiah internetisaiah internetisaiah requested changes

@vanessaland vanessaland vanessaland approved these changes

@davidbielik davidbielik davidbielik left review comments

@bryanlogan bryanlogan bryanlogan approved these changes

Requested changes must be addressed to merge this pull request.

Assignees

@internetisaiah internetisaiah

Labels
cla-signed status: do not merge Could mean research before "in progress" status, or do not merge yet.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@chshapiro @josh-mccrowell-braze @bryanlogan @davidbielik @vanessaland @internetisaiah