-
Notifications
You must be signed in to change notification settings - Fork 167
LG-11917: Update doc to use new version for all client in staging. #9875
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -41,7 +41,7 @@ Steps: | |
|
|
||
| 6. Inspect the `Sources` of the page. Expand the local IP address from which you are serving the page. You should see a folder with a version number in the name, like `acuant/11.N.N`. Check that the version here is the new one — the version you noted in step 1. This screenshot shows where the version number appears in Chrome: | ||
|
|
||
|  | ||
|  | ||
|
|
||
|
|
||
| 7. Assuming the version is correct, you are ready to test it. On your phone, tap to photograph your state ID card. Point the camera at the card. Ensure the SDK finds the edges of the card and captures an image. Normally the SDK will put a yellowish box over the card to show where it believes the edges are. | ||
|
|
@@ -87,6 +87,14 @@ Steps: | |
|
|
||
| Set the default to the new SDK version and the alternate to the old version. (That way, the new version is in place if the A/B testing goes well.) | ||
|
|
||
| **Note**: For testing in `staging`, `idv_acuant_sdk_upgrade_a_b_testing_enabled` can be set to `false` like following to test the new SDK version: | ||
| ```yaml | ||
| idv_acuant_sdk_upgrade_a_b_testing_enabled: false | ||
| idv_acuant_sdk_upgrade_a_b_testing_percent: 50 # ignored | ||
| idv_acuant_sdk_version_alternate: 11.M.M # previous | ||
| idv_acuant_sdk_version_default: 11.N.N # newest | ||
| ``` | ||
| The testing phase should continue until we have accumulated sufficient traffic. | ||
|
||
| 4. Save the file. If the file opened in the vi editor, use `:wq` to save. A diff of your changes will appear. Copy the diff and paste it into the Slack thread. Type `y` to accept the changes. | ||
|
|
||
| 5. Recycle the servers [with these Handbook instructions](https://handbook.login.gov/articles/appdev-deploy.html#production). This will involve: | ||
|
|
@@ -98,6 +106,26 @@ Steps: | |
| 6. While you monitor the recycle, manually check the document capture page in the environment you are deploying to. Ensure the SDK loads and can capture images. | ||
|
|
||
| Monitoring the A/B test begins now. Proceed to the next section. | ||
| ## Testing Considerations | ||
| Manual testing should be performed to cover the following with verification *Success* or *Failure*: | ||
| * SDK UI | ||
| * Camera permission prompt is shown | ||
| * Instruction text for taking ID and selfie | ||
| * Countdown while capturing | ||
| * Auto-capture mode | ||
| * Camera permissions | ||
| * Prompt is shown upon the first time opening the SDK | ||
| * Tapping 'Decline' shows error message on the 'Add photos' page | ||
| * Opening the SDK again shows the same prompt | ||
|
|
||
| Operating systems: | ||
| * iOS | ||
| * Android | ||
|
||
|
|
||
| Browser: | ||
| * Chrome | ||
| * Firefox | ||
| * Safari | ||
|
|
||
| ## Monitor A/B testing | ||
|
|
||
|
|
||
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.
Uh oh!
There was an error while loading. Please reload this page.