Update documentation and tutorial for 2.0 by timkimadobe · Pull Request #35 · adobe/aepsdk-edge-android

timkimadobe · 2023-01-24T22:57:02Z

Description

This PR updates both documentation and tutorial apps to reflect the new Core 2.0 dependencies.
Start/Final app:

Update dependencies to production 2.0.0 versions (will be broken until production versions are available)
Update logs to use Core Services Log
- public LOG_TAG defined in MainApp and static imported into other tutorial app files where needed
res/xml files updated to move the xml definition to the very top (above the generated license), which was causing build errors
Remove jetifier from gradle.properties (assurance 2.0)

Edge Tutorial:

Replace all gitbook docs with updated doc links

API reference:

Add deprecation warning to registerExtension API

Main README:

Update dependencies to latest 2.0.0 version with link to latest extension versions
Replace outdated doc links
Update mobile property instructions to refer to more comprehensive tutorial instructions
Misc. doc cleanup

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

I have signed the Adobe Open Source CLA.
My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

…aepsdk-edge-android into update-tutorial-2.0

codecov · 2023-01-24T23:10:37Z

Codecov Report

Merging #35 (4503009) into dev-v2.0.0 (ad623ab) will not change coverage.
The diff coverage is n/a.

❗ Current head 4503009 differs from pull request most recent head 5b979c7. Consider uploading reports for the commit 5b979c7 to get more accurate results

@@              Coverage Diff              @@
##             dev-v2.0.0      #35   +/-   ##
=============================================
  Coverage         83.05%   83.05%           
  Complexity          361      361           
=============================================
  Files                29       29           
  Lines              1534     1534           
  Branches            217      217           
=============================================
  Hits               1274     1274           
  Misses              161      161           
  Partials             99       99

Flag	Coverage Δ
functional-tests	`66.17% <ø> (ø)`
unit-tests	`79.07% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Update XML files to have xml as absolute first element Update build dependencies to use 2.0 versions of extensions Remove jetifier

Add alternative gradle sync instructions

addb · 2023-01-25T22:08:37Z

README.md

 To open and run the project, open the `code/settings.gradle` file in Android Studio.

-**Data Collection mobile property prerequisites**
+#### **Adobe Experience Platform mobile property prerequisites**


nit: Do we require bold here since its already a header?

Thanks for catching this! Updated to remove bold style

addb · 2023-01-25T22:32:18Z

README.md

 The Adobe Experience Platform Edge Network mobile extension allows you to send data to the Adobe  Edge Network from a mobile application. This extension allows you to implement Adobe Experience Cloud capabilities in a more robust way, serve multiple Adobe solutions though one network call, and simultaneously forward this information to the Adobe Experience Platform.

-The AEP Edge Network mobile extension is an extension for the [Adobe Experience Platform SDK](https://aep-sdks.gitbook.io) and requires the `AEPCore` and `AEPServices` extensions for event handling, as well as the `AEPEdgeIdentity` extension for retrieving the identities, such as ECID.
+The AEP Edge Network mobile extension is an extension for the [Adobe Experience Platform SDK](https://developer.adobe.com/client-sdks/documentation/) and requires the `AEPCore` and `AEPServices` extensions for event handling, as well as the `AEPEdgeIdentity` extension for handling identities, such as `ECID`.


Let's move all non-internal links to one section on Readme and reference that section.

Ok, I consolidated the documentation links and moved its placement to make it more prominent; let me know what you think of the changes!

Update formatting

addb · 2023-01-26T01:14:58Z

README.md

+To learn more about this extension, see the [Adobe Experience Platform Edge Network](https://developer.adobe.com/client-sdks/documentation/edge-network/) documentation.
+
+Additional information about SDK usage and architecture can be found in the [Documentation](Documentation) directory.



Can we reword to something on these lines:

Information regarding AEP Edge Network extension implementation, API usage and architecture can be found in Documentation directory

Learn more about AEP Edge Network extension along with all the other AEP Mobile extensions on the official AEP Mobile documentation.

Thank you! Made some adjustments to the wording, please let me know what you think!

cacheung

getting-started.md still have two links pointing to
aep-sdks.gitbook doc

cacheung · 2023-01-26T20:14:16Z

README.md

-
-Additional documentation for usage and SDK architecture can be found under the [Documentation](Documentation) directory.
+| [AEP Core Extensions](https://github.com/adobe/aepsdk-core-android)                       | The AEPCore and AEPServices represent the foundation of the Adobe Experience Platform SDK. |
+| [AEP onsent Extension](https://github.com/adobe/aepsdk-edgeconsent-android)              | The AEPConsent extension enables consent preferences collection from your mobile app when using the AEP Mobile SDK and the Edge Network extension. |


AEP Consent

cacheung · 2023-01-26T20:18:03Z

README.md

-implementation 'com.adobe.marketing.mobile:edgeidentity:1.+'
-implementation 'com.adobe.marketing.mobile:edge:1.+'
-implementation 'com.adobe.marketing.mobile:core:1.+'
+implementation 'com.adobe.marketing.mobile:core:2.0.0'


We will point this to getting started page.

Integrate the Edge Network extension into your app by including the following the getting started guide.

Are you going to update getting started to 2+ in this PR?
https://github.com/timkimadobe/aepsdk-edge-android/blob/update-tutorial-2.0/Documentation/getting-started.md#add-the-edge-network-extension-to-your-app

You can wait for edgeIdentity doc PR reviewed then change.

cacheung · 2023-01-26T20:19:31Z

Documentation/api-reference.md

 Registers the Edge Network extension with the Mobile Core extension.

+> **Warning**  
+> Deprecated as of 2.0.0. Use the [MobileCore.registerExtensions API](https://developer.adobe.com/client-sdks/documentation/mobile-core/api-reference) instead.


let change the link to https://github.com/adobe/aepsdk-core-android

Replace all usages of acronym

emdobrin

@timkimadobe your changes look great
left small cleanup comments, aside from the README that needs few more updates

...ials/EdgeTutorialAppStart/app/src/main/java/com/adobe/marketing/mobile/tutorial/MainApp.java

...ials/EdgeTutorialAppFinal/app/src/main/java/com/adobe/marketing/mobile/tutorial/MainApp.java

Documentation/Tutorials/edge-send-event-tutorial.md

README.md

Documentation/getting-started-test-app.md

emdobrin · 2023-01-30T19:10:18Z

README.md

 ## Documentation

-Additional documentation for usage and SDK architecture can be found under the [Documentation](Documentation) directory.
+Information about Adobe Experience Platform Edge Network's implementation, API usage, and architecture can be found in the [Documentation](Documentation) directory.


can you include Getting started with the test app in the Documentation/README.md contents table?

emdobrin · 2023-01-30T19:13:30Z

Documentation/getting-started.md

+class MainApp : Application() {

-1. Add the Mobile Core, Identity for Edge Network, and Edge Network extensions to your project using the app's Gradle file:
+  private var ENVIRONMENT_FILE_ID: String = ""


nit: you can use ENVIRONMENT_FILE_ID: String = "YOUR_APP_ENVIRONMENT_ID" similar to java code

emdobrin · 2023-01-30T19:14:08Z

Documentation/getting-started.md

+		MobileCore.configureWithAppID(ENVIRONMENT_FILE_ID);
+
+		MobileCore.registerExtensions(
+			Arrays.asList(Consent.EXTENSION, Edge.EXTENSION, Identity.EXTENSION),


consent is not installed/imported, maybe we can remove from these two examples

addb · 2023-01-30T19:25:22Z

...EdgeTutorialAppFinal/app/src/main/java/com/adobe/marketing/mobile/tutorial/EdgeFragment.java

                        .setXdmSchema(eventData)
                        .build();
-                Log.d(LOG_TAG, "Sending event");
+                Log.debug(LOG_TAG, LOG_SOURCE, "Sending event");


nit: "Sending ProductView Edge event"

...EdgeTutorialAppFinal/app/src/main/java/com/adobe/marketing/mobile/tutorial/EdgeFragment.java

addb · 2023-01-30T19:25:31Z

...EdgeTutorialAppFinal/app/src/main/java/com/adobe/marketing/mobile/tutorial/EdgeFragment.java

                    @Override
                    public void onComplete(final List<EdgeEventHandle> handles) {
-                        Log.d(LOG_TAG, "Edge event callback called");
+                        Log.debug(LOG_TAG, LOG_SOURCE, "Edge event callback called");


nit: "Callback called for ProductAdd Edge event"

...EdgeTutorialAppFinal/app/src/main/java/com/adobe/marketing/mobile/tutorial/MainActivity.java

addb · 2023-01-30T19:41:54Z

Documentation/api-reference.md

 Registers the Edge Network extension with the Mobile Core extension.

+> **Warning**  
+> Deprecated as of 2.0.0. Use the [MobileCore.registerExtensions API](https://github.com/adobe/aepsdk-core-android) instead.


update url: https://github.com/adobe/aepsdk-core-android/blob/staging/Documentation/MobileCore/api-reference.md

let's use main branch for all link references:
https://github.com/adobe/aepsdk-core-android/blob/main/Documentation/MobileCore/api-reference.md

Remove api deeplink

Update doc readme with test app getting started

timkimadobe

Thanks for the reviews @addb and @emdobrin! Updated based on feedback and ready for followup review

timkimadobe · 2023-01-27T22:21:28Z

README.md

+To learn more about this extension, see the [Adobe Experience Platform Edge Network](https://developer.adobe.com/client-sdks/documentation/edge-network/) documentation.
+
+Additional information about SDK usage and architecture can be found in the [Documentation](Documentation) directory.



Thank you! Made some adjustments to the wording, please let me know what you think!

Documentation/getting-started-test-app.md

...EdgeTutorialAppFinal/app/src/main/java/com/adobe/marketing/mobile/tutorial/MainActivity.java

addb

looks good!

timkimadobe added 3 commits January 24, 2023 14:39

Update top level README with updated 2.0 instructions

084f909

Update top level README with updated 2.0 instructions

3abfe7f

Merge branch 'update-tutorial-2.0' of https://github.com/timkimadobe/…

98f7aad

…aepsdk-edge-android into update-tutorial-2.0

timkimadobe added 3 commits January 24, 2023 15:15

Update repo URL

9bd9483

Update final test app to use 2.0 registration and log service

a4d8982

Update XML files to have xml as absolute first element Update build dependencies to use 2.0 versions of extensions Remove jetifier

Update start test app to use 2.0 registration and log service

6fe1120

Update XML files to have xml as absolute first element Update build dependencies to use 2.0 versions of extensions Remove jetifier

timkimadobe marked this pull request as ready for review January 24, 2023 23:38

timkimadobe added 4 commits January 24, 2023 16:18

Update main readme with new doc links and updated instructions

f3e0aba

Add deprecated warning to registerExtension API

efe192a

Update styling

cd46c89

Replace outdated doc link

ef39db5

timkimadobe changed the title ~~Update tutorial 2.0~~ Update documentation and tutorial for 2.0 Jan 25, 2023

Update instruction to be theme agnostic

124e79e

Add alternative gradle sync instructions

emdobrin linked an issue Jan 25, 2023 that may be closed by this pull request

Update tutorial app and docs for 2.0.0 #30

Closed

emdobrin requested review from addb, cacheung and kevinlind January 25, 2023 21:40

addb reviewed Jan 25, 2023

View reviewed changes

timkimadobe added 2 commits January 25, 2023 16:05

Consolidate documentation links in main README

36e4036

Update formatting

Update styling

31ff944

addb reviewed Jan 26, 2023

View reviewed changes

cacheung reviewed Jan 26, 2023

View reviewed changes

Update readme and api reference

00c559d

Replace all usages of acronym

emdobrin added the documentation Improvements or additions to documentation label Jan 27, 2023

emdobrin reviewed Jan 27, 2023

View reviewed changes

timkimadobe added 3 commits January 27, 2023 15:33

Remove link to lifecycle implementation in tutorial

cb93eea

update tutorial app MainApp LOG_SOURCE

3b23ccf

Align main README with edgeconsent layout

27f7e61

timkimadobe added 2 commits January 27, 2023 15:43

Update years for copyright and license

851f890

Update both getting started guides

add4bab

cacheung reviewed Jan 28, 2023

View reviewed changes

Documentation/getting-started-test-app.md Outdated Show resolved Hide resolved

Update assurance connection instructions

4503009

timkimadobe requested review from addb, cacheung and emdobrin January 30, 2023 18:51

emdobrin reviewed Jan 30, 2023

View reviewed changes

addb reviewed Jan 30, 2023

View reviewed changes

...EdgeTutorialAppFinal/app/src/main/java/com/adobe/marketing/mobile/tutorial/EdgeFragment.java Outdated Show resolved Hide resolved

addb reviewed Jan 30, 2023

View reviewed changes

...EdgeTutorialAppFinal/app/src/main/java/com/adobe/marketing/mobile/tutorial/EdgeFragment.java Outdated Show resolved Hide resolved

addb reviewed Jan 30, 2023

View reviewed changes

...EdgeTutorialAppFinal/app/src/main/java/com/adobe/marketing/mobile/tutorial/MainActivity.java Outdated Show resolved Hide resolved

addb reviewed Jan 30, 2023

View reviewed changes

timkimadobe added 4 commits January 30, 2023 13:26

Update tutorial app log statements

b6407b9

Remove api deeplink

Update tutorial app logs

8762ac2

Update api doc url

5d80051

Update getting started example registration

75e44bd

Update doc readme with test app getting started

timkimadobe commented Jan 30, 2023

View reviewed changes

Fix swift syntax to java

5b979c7

addb approved these changes Jan 30, 2023

View reviewed changes

timkimadobe merged commit 8939775 into adobe:dev-v2.0.0 Jan 30, 2023

timkimadobe deleted the update-tutorial-2.0 branch January 30, 2023 22:06

		To learn more about this extension, see the [Adobe Experience Platform Edge Network](https://developer.adobe.com/client-sdks/documentation/edge-network/) documentation.

		Additional information about SDK usage and architecture can be found in the [Documentation](Documentation) directory.

Conversation

timkimadobe commented Jan 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Uh oh!

codecov bot commented Jan 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

addb Jan 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

addb Jan 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

addb Jan 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cacheung left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

emdobrin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

timkimadobe left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

timkimadobe commented Jan 24, 2023 •

edited

Loading

codecov bot commented Jan 24, 2023 •

edited

Loading

addb Jan 25, 2023 •

edited

Loading

addb Jan 25, 2023 •

edited

Loading

addb Jan 26, 2023 •

edited

Loading