Conversation
Migration of Edge tutorial to Edge repo
Refactoring file structure
Update steps for Edge, add sections for various AEP extensions
Update file structure to place tutorials in documentation in line with other repos
Remove duplicated tutorial and update assurance window step
Update edge example with one using XDM object
Update tutorial for edge
Step updates
Tutorial for `sendEvent` - fresh implementation state
Update AEP setup heading level
Reset app to start state
Refinement of Edge `sendEvent` tutorial
Update section numbering
Update git repo link to point to tutorial branch
Update repo setup instructions to point to tutorial project
Refinements for Edge `sendEvent` tutorial
Update podfile instructions
Remove unneeded pod update step Clarify click and drag step
Update click and drag with image Update wording for datastream description
Update click and drag with step numbers
Update property extension installation to include assurance Update publishing steps update env id saving
Remove trigger consequence button
Flesh out rule creation steps
Tutorial refinements
Add Analytics service to datastream steps
Update assurance validation to include analytics mapping and event transactions
Update tutorial app to starting state
Tutorial refinement
Update pod instructions since opening for the first time has invalid Pod target Allow alternative route using SPM if no admin access
Update top level diagram
Update top level diagram
Create final state for edge tutorial app
Documentation/Tutorials/EdgeTutorialAppStart/EdgeTutorialAppStart/xdm/CartAbandons.swift
Outdated
Show resolved
Hide resolved
| import AEPEdgeConsent | ||
| import AEPEdgeIdentity | ||
| import AEPLifecycle | ||
| // Edge Tutorial - code section (1/3) */ |
There was a problem hiding this comment.
Would this app be used for other tutorials as well? If so, we can rename the sections accordingly to accommodate for that, for example we can have all comments like:
// Edge Tutorial 1 - code section (n/m)
and in the table of contents we refer to sendEvent as tutorial 1.
There was a problem hiding this comment.
Yes I think the idea was to use this app's end point as the starting point for other extensions that use Edge extensions; however, does the numbering reflect the number of tutorials for Edge? or the required tutorial order (for example, when another extension builds off of this one would it be 2?)?
There was a problem hiding this comment.
I was thinking the number of tutorials in Edge. In case we have tutorial 2 and 3 in the future and use the same app, the steps may be conflicting with tutorial 1.
But if the same app code will be used in other repos, might be confusing though.
We can keep it as is for now and we can decide when new tutorials are added.
timkimadobe
left a comment
There was a problem hiding this comment.
Thanks for the review Emilia, updated based on feedback with some outstanding questions
Create TOC under Tutorials directory
Remove branch from repo link
Remove initial pod update
Create final state for edge tutorial app
| ### Consent for Edge extension <!-- omit in toc --> | ||
| The [Consent for Edge](https://aep-sdks.gitbook.io/docs/foundation-extensions/consent-for-edge-network) mobile extension enables you to collect user data tracking consent preferences from your mobile app when using AEP and the Edge extension. The default consent settings should be set in alignment with your organization's user data privacy requirements. See the guide on [ingesting data using the Consents and Preferences data type](https://experienceleague.adobe.com/docs/experience-platform/xdm/data-types/consents.html#ingest). | ||
|
|
||
| [API documentation](https://aep-sdks.gitbook.io/docs/foundation-extensions/consent-for-edge-network/api-reference) | ||
|
|
||
| ### Identity for Edge extension <!-- omit in toc --> | ||
| The [Identity for Edge](https://aep-sdks.gitbook.io/docs/foundation-extensions/identity-for-edge-network) mobile extension enables identity management when using AEP and the Edge extension. You can control IDs associated with the user like custom IDs, advertising IDs, etc. | ||
|
|
||
| [API documentation](https://aep-sdks.gitbook.io/docs/foundation-extensions/identity-for-edge-network/api-reference) | ||
|
|
||
| ### Lifecycle for Edge extension <!-- omit in toc --> | ||
| The [Lifecycle for Edge](https://aep-sdks.gitbook.io/docs/foundation-extensions/lifecycle-for-edge-network) extension enables you to collect app lifecycle data from your mobile app when using AEP and the Edge extension. This includes data like app start, stop, device type, device OS, etc. | ||
|
|
||
| [API documentation](https://aep-sdks.gitbook.io/docs/foundation-extensions/mobile-core/lifecycle/lifecycle-api-reference) |
There was a problem hiding this comment.
Yes, let's do that since it will reduce the amount of external links we have. We can keep just the note about lifecycle implementation L498 which is related to the tutorial.
| import AEPEdgeConsent | ||
| import AEPEdgeIdentity | ||
| import AEPLifecycle | ||
| // Edge Tutorial - code section (1/3) */ |
There was a problem hiding this comment.
I was thinking the number of tutorials in Edge. In case we have tutorial 2 and 3 in the future and use the same app, the steps may be conflicting with tutorial 1.
But if the same app code will be used in other repos, might be confusing though.
We can keep it as is for now and we can decide when new tutorials are added.
Update related projects and point to it from tutorial
Update assurance step header and toc
Update tutorial
emdobrin
left a comment
There was a problem hiding this comment.
Requires few small updates and is good to go!
Update app name usages
Update app name usages
Codecov Report
@@ Coverage Diff @@
## dev #274 +/- ##
==========================================
+ Coverage 95.06% 95.50% +0.44%
==========================================
Files 27 28 +1
Lines 1032 1045 +13
==========================================
+ Hits 981 998 +17
+ Misses 51 47 -4 |
Description
This PR contains the tutorial for the Edge
sendEventend to end implementation. At a high level it contains:Related Issue
See MOB-17361 for additional details.
Motivation and Context
This tutorial helps users better understand how to set up - from scratch - the Edge extensions to send XDM Experience Events and validate them using Assurance. It is geared towards assuming no prior knowledge of the Adobe Experience Platform, Edge extensions, or Assurance (and all their associated configuration requirements, etc.), or extensive software development experience.
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: