[PWA-75] Add PWA Wrapper documentation and capabilities overview#10931
[PWA-75] Add PWA Wrapper documentation and capabilities overview#10931YogendraShelke wants to merge 7 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!
content/en/docs/refguide/mobile/pwa-wrapper/pwa-wrapper-capabilities.md
Outdated
Show resolved
Hide resolved
content/en/docs/refguide/mobile/pwa-wrapper/pwa-wrapper-limitations.md
Outdated
Show resolved
Hide resolved
| 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.
| ## 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.
MarkvanMents
left a comment
There was a problem hiding this comment.
I have now finished my review.
I have a few minor questions, but my main concern is the position of these documents in the navigation.
I'll open a chat on Slack to make the discussion easier.
Thanks for the big PR - apologies for the delay in dealing with it.
content/en/docs/refguide/mobile/pwa-wrapper/pwa-wrapper-capabilities.md
Outdated
Show resolved
Hide resolved
|
|
||
| Support can vary by platform, operating system version, browser engine, and configured permissions. Always test the capabilities you depend on on the actual devices you plan to support. | ||
|
|
||
| In the current beta release, PWA Wrapper capabilities are documented for Android and iOS. |
There was a problem hiding this comment.
We list capabilities but don't actually identify any which are not available for Android or iOS. I don't think we need to say this - and we can always expand the tbale in the permission mapping if we decide to support other operating systems.
| * the app is loaded over HTTPS | ||
| * the app is accessed from `localhost` during local development | ||
|
|
||
| If the wrapped app is loaded from an insecure HTTP origin, capabilities that depend on Web APIs such as geolocation, notifications, permission handling, network information, or Share API flows may not work as expected. |
There was a problem hiding this comment.
Is this something the user should be handling as described in Designing with Capabilities?
content/en/docs/refguide/mobile/pwa-wrapper/pwa-wrapper-limitations.md
Outdated
Show resolved
Hide resolved
|
|
||
| ## Introduction | ||
|
|
||
| This page summarizes the main cross-cutting limitations of PWA Wrapper in the current beta release. |
There was a problem hiding this comment.
What do you mean by "cross-cutting"?
No description provided.