[PWA-75] Add PWA Wrapper documentation and capabilities overview#10931
[PWA-75] Add PWA Wrapper documentation and capabilities overview#10931YogendraShelke wants to merge 6 commits intomendix:developmentfrom
Conversation
|
Are these docs tied to a release (SP or otherwise) or can they be merged whenever @YogendraShelke ? |
PWA Wrapper will be announced with the 11.9 release, but it is also supported on 10.24. It makes sense to publish these docs only after the PWA Wrapper marketplace module is released. I will confirm the timing once that release is completed. |
|
Ok, thank you @YogendraShelke, I'll wait to merge until you confirm the module release date. Cheers. |
|
Hi @ConnorLand, the PWA Wrapper has been published on the Marketplace. You can proceed with publishing the documentation now. |
|
I didn't get to editing these this week, but it's the top of my list for editing/merging when I get back from PTO on April 13 @YogendraShelke . It's got prio. |
jdiehl
left a comment
There was a problem hiding this comment.
Great job on the documentation! Very clear!
|
|
||
| Keep the following beta limitations in mind: | ||
|
|
||
| * The current beta release supports Android and iOS only |
There was a problem hiding this comment.
Please remove this - see above for reasoning
|
|
||
| PWA Wrapper lets you package a Mendix progressive web app (PWA) as a native mobile app for Android and iOS. This is useful when you want to keep a web-based application architecture while distributing the app through app stores, installing it on managed devices, or adding a small set of commonly used hardware capabilities. | ||
|
|
||
| In the current beta release, the scope of PWA Wrapper is limited to Android and iOS. |
There was a problem hiding this comment.
Please remove this - I don't think limiting support to Android and iOS is a true limitation. We can introduce harmony os and other architectures later as features, not as limitation removers
| When you build a Mendix app with PWA Wrapper capabilities, follow these guidelines: | ||
|
|
||
| * Request permissions only when they are needed in the user flow | ||
| * Add clear fallback logic for devices where a capability is unavailable |
There was a problem hiding this comment.
Replace with below's broader guideline that also includes users rejecting access:
- Handle denied permissions or unsupported devices by providing clear fallback logic.
|
|
||
| Keep the following product-level limitations in mind: | ||
|
|
||
| * The current beta release supports Android and iOS only |
| Keep the following recommendations in mind: | ||
|
|
||
| * Use one stable signing configuration per app line if you plan to publish updates | ||
| * Back up the generated Android signing directory before moving to another machine |
There was a problem hiding this comment.
Please add instructions where to find the Android keystore
There was a problem hiding this comment.
Is this not the place mentioned in the Manage Signing Configurations section, above?
MarkvanMents
left a comment
There was a problem hiding this comment.
I am most of the way through the review.
I wonder whether this documentation should be in a non-versioned area such as Marketplace. It doesn't make sense to be saying that it can be used on 10.24 when the documentation is in the Mendix 11 documentation. We could just have a landing page here, but all the instructions in the Marketplace.
I also see that the Marketplace module is not platform supported. Should this be changed now, or only when it comes out of beta.
I'll complete the review tomorrow.
|
|
||
| PWA Wrapper lets you package a Mendix progressive web app (PWA) as a native mobile app for Android and iOS. This is useful when you want to keep a web-based application architecture while distributing the app through app stores, installing it on managed devices, or adding a small set of commonly used hardware capabilities. | ||
|
|
||
| In the current beta release, the scope of PWA Wrapper is limited to Android and iOS. |
|
|
||
| Keep the following beta limitations in mind: | ||
|
|
||
| * The current beta release supports Android and iOS only |
| ## Read More | ||
|
|
||
| * [Install PWA Wrapper](/refguide/mobile/pwa-wrapper/install-pwa-wrapper/) | ||
| * [Build PWA Wrapper Apps](/refguide/mobile/pwa-wrapper/build-pwa-wrapper-apps/) | ||
| * [Sign PWA Wrapper Apps](/refguide/mobile/pwa-wrapper/sign-pwa-wrapper-apps/) | ||
| * [PWA Wrapper Capabilities](/refguide/mobile/pwa-wrapper/pwa-wrapper-capabilities/) | ||
| * [PWA Wrapper Limitations](/refguide/mobile/pwa-wrapper/pwa-wrapper-limitations/) |
There was a problem hiding this comment.
I don't think we need these - we normally only add Read More sections if the sections aren't linked above - and we already have all these listed very clearly.
| ## Choosing Permissions and Packaging Options | ||
|
|
||
| When configuring the wrapper, only enable the permissions and capabilities that your app actually uses. This reduces unnecessary prompts for end users and makes app review easier. | ||
|
|
||
| For a practical mapping between capabilities and the permissions you typically need to configure, see [Capability to Permission Mapping](/refguide/mobile/pwa-wrapper/pwa-wrapper-capabilities/#capability-to-permission-mapping). | ||
|
|
There was a problem hiding this comment.
This seems to duplicate what is already in the steps. I don't think it adds anything.
|
|
||
| For a practical mapping between capabilities and the permissions you typically need to configure, see [Capability to Permission Mapping](/refguide/mobile/pwa-wrapper/pwa-wrapper-capabilities/#capability-to-permission-mapping). | ||
|
|
||
| If the builder offers a choice to skip copying web resources, use that option carefully. Skipping resource copy makes packaging faster, but the wrapped app will fetch its frontend resources from the runtime instead of using packaged resources. |
There was a problem hiding this comment.
This should be in the Android section only as you can't package resources on an iOS.
|
|
||
| This page explains the signing step within the PWA Wrapper build flow. It covers Android signing on Windows and macOS, iOS signing on macOS, and the Windows-to-macOS handoff required for final iOS signing. | ||
|
|
||
| Use this page as a reference while completing [Build PWA Wrapper Apps](/refguide/mobile/pwa-wrapper/build-pwa-wrapper-apps/). |
There was a problem hiding this comment.
Not sure what you mean here. If there are things that need referencing then the links should be in the build guide. I don't think we need to mention it here.
| Keep the following recommendations in mind: | ||
|
|
||
| * Use one stable signing configuration per app line if you plan to publish updates | ||
| * Back up the generated Android signing directory before moving to another machine |
There was a problem hiding this comment.
Is this not the place mentioned in the Manage Signing Configurations section, above?
| 1. Open PWA Wrapper and select **Android**. | ||
| 2. Go to the signing step. | ||
| 3. Select **Create New Signature**. | ||
| 4. Enter a unique signature name such as `test`, `qa`, or `production`. |
There was a problem hiding this comment.
The one in the image isn't any of these, it is "debug". I think the suggestions should match the image.
No description provided.