Optimize setup docs #103

dsoffiantini · 2022-10-25T21:48:27Z

Description

Adds documentation about the assurance optimize setup view

calebk1

Some small fixes!

calebk1 · 2022-10-25T23:00:51Z

src/pages/documentation/platform-assurance/tutorials/optimize-configuration-view.md

+1. [Set up Assurance](../set-up-project-griffon.md)
+2. [Create](./README.md#creating-sessions) and [connect](./README.md#connecting-to-a-session) to a Assurance session


Same comment here - we need to update these links to the proper links within this repo.

So I think it's set-up.md for Set up Assurance, and index.md instead of README.md.

calebk1 · 2022-10-25T23:02:39Z

src/pages/documentation/platform-assurance/tutorials/optimize-configuration-view.md

+
+## Datastream Setup Validation
+
+At the top of the Optimize Setup Validation view, Assurance inspects your current app's datastream, and looks to see if Target or Offer Decisioning has been enabled. In order to use optimize, at least one of extensions needs to be enabled inside your datastream.


Since this is a first mention, this should be "... Platform Assurance inspects your current app's..."

calebk1 · 2022-10-25T23:11:01Z

src/pages/documentation/platform-assurance/tutorials/optimize-configuration-view.md

+
+## SDK Setup Validation
+
+Below the datastream validation section, the SDK Setup Validation section offers feedback on two major issues you could face in your application. First it offers validation that you have installed all the required SDKs Optimize requires in order to work correctly. Second, it validates that request and response events are flowing from your application in the way the platform expects them to. Errors may arise if your schemas have been improperly implemented, or your app may be sending requests that do not receive an appropriate response. In these cases, this section will give feedback about what is going wrong, and identify the events in error so that you can diagnose what went wrong.


"Firstly, it offers validation that you have..."
"Secondly, it validates that the request and response events are..."

calebk1

Just a few more minor comments!

calebk1 · 2022-10-26T17:37:25Z

gatsby-config.js

@@ -698,6 +698,10 @@ module.exports = {
                                title: "Custom validation",
                                path: "/documentation/platform-assurance/tutorials/custom-validation.md"
                            },
+                            {
+                                title: "Optimize Setup",


To match with the other ones, this should be "Optimize setup".

(I believe it's sentence-casing, rather than title-casing for documentation, unfortunately.)

calebk1 · 2022-10-26T18:12:07Z

src/pages/documentation/platform-assurance/tutorials/optimize-configuration-view.md

+To use this view, complete the following steps:
+
+1. [Set up Adobe Experience Platform Assurance](../set-up.md)
+2. [Create](./index.md#creating-sessions) and [connect](./index.md#connecting-to-a-session) to a Assurance session


"... to an Assurance session".

calebk1 · 2022-10-26T18:20:22Z

src/pages/documentation/platform-assurance/tutorials/optimize-configuration-view.md

@@ -0,0 +1,35 @@
+# Optimize Setup Validation View


Lowercase v for view, because of sentence casing.

emdobrin · 2022-11-22T21:20:39Z

@hbhandal80 @sbenedicadb can you help with a review on this PR?

hbhandal80

Comments left, please make updates.

hbhandal80 · 2022-11-22T22:31:15Z

src/pages/documentation/platform-assurance/tutorials/optimize-configuration-view.md

+
+## Overview
+
+You may use the Optimize Setup Validation view in order to quickly see if your app has been successfully set up to use AEP Optimize. The view validates all pre-requisites have been met, and offers feedback on how to fix your setup in cases where requirements have been missed.


I would reword the first sentence: "You can use the Optimize Setup Validation view to check if your application has been set up successfully to use Adobe Experience Platform Optimize."

hbhandal80 · 2022-11-22T22:37:29Z

src/pages/documentation/platform-assurance/tutorials/optimize-configuration-view.md

+
+## Getting Started
+
+To use this view, complete the following steps:


Suggest amending this to - "To use this view, follow the steps outlined below:"

hbhandal80 · 2022-11-22T22:49:18Z

src/pages/documentation/platform-assurance/tutorials/optimize-configuration-view.md

+
+## Datastream Setup Validation
+
+At the top of the Optimize Setup Validation view, Platform Assurance inspects your current app's datastream, and looks to see if Target or Offer Decisioning has been enabled. In order to use optimize, at least one of extensions needs to be enabled inside your datastream.


Suggest amending the first sentence slightly: "....your current application's datastream to see if Target or Offer Decisioning has been enabled.

hbhandal80 · 2022-11-22T22:50:12Z

src/pages/documentation/platform-assurance/tutorials/optimize-configuration-view.md

+
+![Validate Datastream Section](./assets/optimize-configuration/datastream-validation.png)
+
+To enable Target in your datastream, go to the datastream view for your app inside the Data Collection UI, and ensure that Adobe Target has been added and enabled.


change "app" to "application".

hbhandal80 · 2022-11-22T23:01:36Z

src/pages/documentation/platform-assurance/tutorials/optimize-configuration-view.md

+
+![Enable Target Datastream](./assets/optimize-configuration/enable-target-datastream.png)
+
+To enable Offer Decisioning in your datastream, go to the datastream view for your app inside the Data Collection UI, and then select Edit inside the actions menu for Adobe Experience Platform. Inside, you will see a checkbox that shows whether Offer Decisioning has been enabled.


Suggest rewording this section: "To enable Offer Decisioning in your datastream, go to datastream view for your application in the Data Collection UI, and select Edit in the actions menu for Adobe Experience Platform. The toggle shows if Offer Decisioning is enabled."

hbhandal80 · 2022-11-22T23:18:38Z

src/pages/documentation/platform-assurance/tutorials/optimize-configuration-view.md

+
+## SDK Setup Validation
+
+Below the datastream validation section, the SDK Setup Validation section offers feedback on two major issues you could face in your application. Firstly, it offers validation that you have installed all the required SDKs Optimize requires in order to work correctly. Secondly, it validates that the request and response events are are flowing from your application in the way the platform expects them to. Errors may arise if your schemas have been improperly implemented, or your app may be sending requests that do not receive an appropriate response. In these cases, this section will give feedback about what is going wrong, and identify the events in error so that you can diagnose what went wrong.


Suggest rewording: "Firstly, it offers validation that all SDKs have been installed that are required by Optimize to work correctly."

Remove "are" appears twice: "....events are flowing from...."

Suggest updating to - "Errors may arise if your schemas have been improperly implemented, or your application is sending requests that do not receive an appropriate response. This section will provide feedback and identify the events in error, so you can diagnose what went wrong."

dsoffiantini · 2023-03-03T18:21:28Z

@hbhandal80 sorry I missed your comments earlier and forgot about this one, should be updated with your feedback!

…gatsby-theme-aio-4.10.5 Bump @adobe/gatsby-theme-aio from 4.10.4 to 4.10.5

Metadata

* Create release-pr.yml * no message * Update update-release-notes.js * Update release-pr.yml * no message * Update release-pr.yml * Update release-pr.yml * clean up BOM scripts * add the license header * cleanup * Update update-release-notes.js * address review comments * address review comments * merge BOM release notes to the existing section when the release date exists

* places ios 4.1.0 and android 2.1.0 release notes * Places release doc updates * fix link --------- Co-authored-by: Pravin Prakash Kumar <pprakash@Pravins-MBP.attlocal.net> Co-authored-by: Pravin Prakash Kumar <pprakash@Pravins-MacBook-Pro.local> Co-authored-by: Emilia Dobrin <33132425+emdobrin@users.noreply.github.com>

* Update release notes for Core 4.1.0 and 2.4.0 * minor fix * Fix style

…o mob-20134

MOB-20134 - Command overrides: migrate from datastreams docs to mobile SDK docs

…io-4.11.0

…gatsby-theme-aio-4.11.0 Bump @adobe/gatsby-theme-aio from 4.10.7 to 4.11.0

-release notes for acc-2.1.1

MOB-20239 - Small typo and 404 link: streaming media for edge - READY

* Updating release notes * remove beta version from the release notes --------- Co-authored-by: yangyansong-adbe <yangyansong-adbe@users.noreply.github.com> Co-authored-by: yansong <yanyang@adobe.com>

Bumps [@adobe/gatsby-theme-aio](https://github.com/adobe/aio-theme) from 4.11.0 to 4.11.2. - [Release notes](https://github.com/adobe/aio-theme/releases) - [Commits](https://github.com/adobe/aio-theme/compare/@adobe/gatsby-theme-aio@4.11.0...@adobe/gatsby-theme-aio@4.11.2) --- updated-dependencies: - dependency-name: "@adobe/gatsby-theme-aio" dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>

…gatsby-theme-aio-4.11.2 Bump @adobe/gatsby-theme-aio from 4.11.0 to 4.11.2

…ntent callback (#486)

Bumps [@adobe/gatsby-theme-aio](https://github.com/adobe/aio-theme) from 4.11.2 to 4.11.3. - [Release notes](https://github.com/adobe/aio-theme/releases) - [Commits](https://github.com/adobe/aio-theme/compare/@adobe/gatsby-theme-aio@4.11.2...@adobe/gatsby-theme-aio@4.11.3) --- updated-dependencies: - dependency-name: "@adobe/gatsby-theme-aio" dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>

…gatsby-theme-aio-4.11.3 Bump @adobe/gatsby-theme-aio from 4.11.2 to 4.11.3

* Updating release notes * rename the release name for React Native wrappers --------- Co-authored-by: yangyansong-adbe <yangyansong-adbe@users.noreply.github.com> Co-authored-by: yansong <yanyang@adobe.com>

* Updated release notes for Target iOS and Android releases * Fixed lint issues * Incorporated feedback

Co-authored-by: yangyansong-adbe <yangyansong-adbe@users.noreply.github.com>

Link fix

Co-authored-by: yangyansong-adbe <yangyansong-adbe@users.noreply.github.com>

Updating release notes

Co-authored-by: praveek <praveek@users.noreply.github.com>

dsoffiantini changed the base branch from main to staging October 25, 2022 21:49

calebk1 requested changes Oct 25, 2022

View reviewed changes

dsoffiantini force-pushed the optimize-setup-docs branch 2 times, most recently from 50d859a to 5f3c6ef Compare October 26, 2022 17:31

dsoffiantini requested a review from calebk1 October 26, 2022 17:31

calebk1 requested changes Oct 26, 2022

View reviewed changes

emdobrin requested a review from swarna04 November 1, 2022 16:04

dsoffiantini force-pushed the optimize-setup-docs branch from 5f3c6ef to 308f8ce Compare November 22, 2022 19:04

dsoffiantini requested a review from calebk1 November 22, 2022 19:05

emdobrin requested review from sbenedicadb and hbhandal80 November 22, 2022 21:20

emdobrin mentioned this pull request Nov 22, 2022

docs: 📝 adds docs for optimize setup view Adobe-Marketing-Cloud/aep-sdks-documentation#810

Closed

hbhandal80 requested changes Nov 22, 2022

View reviewed changes

emdobrin force-pushed the staging branch from 209ef9c to 3ea05cb Compare November 29, 2022 21:43

dsoffiantini force-pushed the optimize-setup-docs branch from 308f8ce to 032510f Compare March 3, 2023 18:01

dsoffiantini requested a review from hbhandal80 March 3, 2023 18:02

calebk1 and others added 12 commits August 25, 2023 10:41

Merge pull request #398 from AdobeDocs/dependabot/npm_and_yarn/adobe/…

d2624d1

…gatsby-theme-aio-4.10.5 Bump @adobe/gatsby-theme-aio from 4.10.4 to 4.10.5

more verification fixes

88b005a

Merge branch 'main' into metadata

d9ed003

Adding no-index tags on all the tab stubs

e9ae1bc

Should be a capital L

68b6db5

Merge pull request #274 from calebk1/metadata

eb668f3

Metadata

Release notes for Android Optimize SDK v2.0.1

0b8d88f

Merge pull request #399 from swarna04/optimize-2.0.1

3d1b6bb

Update release notes for Core 4.1.0 and 2.4.0 (#400)

02c98d1

* Update release notes for Core 4.1.0 and 2.4.0 * minor fix * Fix style

Updated iOS Optimize SDK release notes (v4.0.1) (#401)

8c04a3e

calebk1 and others added 27 commits January 22, 2024 13:10

Verbiage fix

63785a4

Merge branch 'mob-20134' of github.com:calebk1/aep-mobile-sdkdocs int…

cb702d2

…o mob-20134

Merge pull request #461 from calebk1/mob-20134

db538ae

MOB-20134 - Command overrides: migrate from datastreams docs to mobile SDK docs

Merge branch 'main' into dependabot/npm_and_yarn/adobe/gatsby-theme-a…

79859db

…io-4.11.0

Merge pull request #471 from AdobeDocs/dependabot/npm_and_yarn/adobe/…

90bfa0b

…gatsby-theme-aio-4.11.0 Bump @adobe/gatsby-theme-aio from 4.10.7 to 4.11.0

Merge branch 'main' into acc-v2.1.1

534e87b

Merge pull request #479 from sbenedicadb/acc-v2.1.1

9266218

-release notes for acc-2.1.1

Small fixes

e9d58cb

Merge branch 'main' into an-338497

65bd0aa

Merge pull request #480 from calebk1/an-338497

cbe3f85

MOB-20239 - Small typo and 404 link: streaming media for edge - READY

Updating release notes (#482)

cbe423d

* Updating release notes * remove beta version from the release notes --------- Co-authored-by: yangyansong-adbe <yangyansong-adbe@users.noreply.github.com> Co-authored-by: yansong <yanyang@adobe.com>

Merge pull request #485 from AdobeDocs/dependabot/npm_and_yarn/adobe/…

c2863ee

…gatsby-theme-aio-4.11.2 Bump @adobe/gatsby-theme-aio from 4.11.0 to 4.11.2

Fixed Target docs for reading response tokens from retrieveLocationCo…

7912f2a

…ntent callback (#486)

Merge pull request #488 from AdobeDocs/dependabot/npm_and_yarn/adobe/…

29228ab

…gatsby-theme-aio-4.11.3 Bump @adobe/gatsby-theme-aio from 4.11.2 to 4.11.3

Updating release notes (#487)

bbf5cd8

* Updating release notes * rename the release name for React Native wrappers --------- Co-authored-by: yangyansong-adbe <yangyansong-adbe@users.noreply.github.com> Co-authored-by: yansong <yanyang@adobe.com>

Updated release notes for Target iOS and Android releases (#489)

173c2b9

* Updated release notes for Target iOS and Android releases * Fixed lint issues * Incorporated feedback

Updating release notes (#490)

bfd20cf

Co-authored-by: yangyansong-adbe <yangyansong-adbe@users.noreply.github.com>

Updating release notes (#493)

3cd07f2

Co-authored-by: yangyansong-adbe <yangyansong-adbe@users.noreply.github.com>

Link fix

800c0dd

Merge pull request #495 from calebk1/fix

fa55ad0

Link fix

Updating release notes (#496)

660e9a7

Co-authored-by: yangyansong-adbe <yangyansong-adbe@users.noreply.github.com>

Updating release notes

f4419f4

Merge pull request #497 from AdobeDocs/update-release-notes

fa7cb11

Updating release notes

Updating release notes (#498)

fb8e1dc

Co-authored-by: praveek <praveek@users.noreply.github.com>

docs: 📝 adds docs for optimize setup view

0aa8c23

dsoffiantini force-pushed the optimize-setup-docs branch from bb9739b to 0aa8c23 Compare February 16, 2024 18:13

dsoffiantini closed this Feb 16, 2024

dsoffiantini deleted the optimize-setup-docs branch February 16, 2024 18:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Optimize setup docs #103

Optimize setup docs #103

dsoffiantini commented Oct 25, 2022

calebk1 left a comment

calebk1 Oct 25, 2022

calebk1 Oct 25, 2022

calebk1 Oct 25, 2022

calebk1 left a comment

calebk1 Oct 26, 2022

calebk1 Oct 26, 2022

calebk1 Oct 26, 2022

emdobrin commented Nov 22, 2022

hbhandal80 left a comment

hbhandal80 Nov 22, 2022

hbhandal80 Nov 22, 2022

hbhandal80 Nov 22, 2022

hbhandal80 Nov 22, 2022

hbhandal80 Nov 22, 2022

hbhandal80 Nov 22, 2022

dsoffiantini commented Mar 3, 2023

		1. [Set up Assurance](../set-up-project-griffon.md)
		2. [Create](./README.md#creating-sessions) and [connect](./README.md#connecting-to-a-session) to a Assurance session


		## Datastream Setup Validation

		At the top of the Optimize Setup Validation view, Assurance inspects your current app's datastream, and looks to see if Target or Offer Decisioning has been enabled. In order to use optimize, at least one of extensions needs to be enabled inside your datastream.


		## SDK Setup Validation

		Below the datastream validation section, the SDK Setup Validation section offers feedback on two major issues you could face in your application. First it offers validation that you have installed all the required SDKs Optimize requires in order to work correctly. Second, it validates that request and response events are flowing from your application in the way the platform expects them to. Errors may arise if your schemas have been improperly implemented, or your app may be sending requests that do not receive an appropriate response. In these cases, this section will give feedback about what is going wrong, and identify the events in error so that you can diagnose what went wrong.


		## Overview

		You may use the Optimize Setup Validation view in order to quickly see if your app has been successfully set up to use AEP Optimize. The view validates all pre-requisites have been met, and offers feedback on how to fix your setup in cases where requirements have been missed.


		## Getting Started

		To use this view, complete the following steps:


		![Validate Datastream Section](./assets/optimize-configuration/datastream-validation.png)

		To enable Target in your datastream, go to the datastream view for your app inside the Data Collection UI, and ensure that Adobe Target has been added and enabled.


		![Enable Target Datastream](./assets/optimize-configuration/enable-target-datastream.png)

		To enable Offer Decisioning in your datastream, go to the datastream view for your app inside the Data Collection UI, and then select Edit inside the actions menu for Adobe Experience Platform. Inside, you will see a checkbox that shows whether Offer Decisioning has been enabled.

Optimize setup docs #103

Optimize setup docs #103

Conversation

dsoffiantini commented Oct 25, 2022

Description

calebk1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

calebk1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emdobrin commented Nov 22, 2022

hbhandal80 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dsoffiantini commented Mar 3, 2023