docs: 📝 adds docs for optimize setup view #501
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
calebk1
requested changes
Feb 23, 2024
| @@ -0,0 +1,35 @@ | |||
| # Optimize Setup Validation view | |||
There was a problem hiding this comment.
We'll need to add metadata on top. You can refer to other pages on the repo to learn how to add metadata! (Or just ping me. I can walk you through it as well.)
|
|
||
| ## Overview | ||
|
|
||
| You can use the Optimize Setup Validation view to check if your application has been set up successfully to use Adobe Experience Platform 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. |
There was a problem hiding this comment.
No need for the comma between "... have been met..." and "... and offers feedback..."
|
|
||
| You can use the Optimize Setup Validation view to check if your application has been set up successfully to use Adobe Experience Platform 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 |
There was a problem hiding this comment.
Minor nit - we generally sentence case for our headers, so this should just be "Getting started". This goes for the subsequent headers as well.
|
|
||
| ## Datastream Setup Validation | ||
|
|
||
| At the top of the Optimize Setup Validation view, Platform Assurance inspects your current application's datastream 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. |
There was a problem hiding this comment.
I believe the secondary usage of Assurance is just Assurance by itself, we can just say "... view, Assurance inspects your..."
|
|
||
| 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 all SDKs have been installed that are required by Optimize to work correctly. Secondly, it validates that the 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 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. | ||
|
|
||
|  |
There was a problem hiding this comment.
Are we missing the feedback part?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds docs for optimize setup view
Types of changes
Checklist: