You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@cordova.apache.org by "erisu (via GitHub)" <gi...@apache.org> on 2023/05/30 11:24:34 UTC
[GitHub] [cordova-docs] erisu opened a new pull request, #1319: doc: config.xml page improvements
erisu opened a new pull request, #1319:
URL: https://github.com/apache/cordova-docs/pull/1319
### Motivation and Context
<!-- Why is this change required? What problem does it solve? -->
<!-- If it fixes an open issue, please link to the issue here. -->
Various improvements on the config.xml page.
### Description
<!-- Describe your changes in detail -->
- Clarity
- Formatting
- Layout
- Wording
### Testing
<!-- Please describe in detail how you tested your changes. -->
n/a
### Checklist
- [ ] I've run the tests to see all new and existing tests pass
- [ ] I added automated test coverage as appropriate for this change
- [ ] Commit is prefixed with `(platform)` if this change only applies to one platform (e.g. `(android)`)
- [ ] If this Pull Request resolves an issue, I linked to the issue in the text above (and used the correct [keyword to close issues using keywords](https://help.github.com/articles/closing-issues-using-keywords/))
- [x] I've updated the documentation if necessary
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For additional commands, e-mail: issues-help@cordova.apache.org
[GitHub] [cordova-docs] erisu merged pull request #1319: doc: various page improvements
Posted by "erisu (via GitHub)" <gi...@apache.org>.
erisu merged PR #1319:
URL: https://github.com/apache/cordova-docs/pull/1319
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For additional commands, e-mail: issues-help@cordova.apache.org
[GitHub] [cordova-docs] NiklasMerz commented on a diff in pull request #1319: doc: various page improvements
Posted by "NiklasMerz (via GitHub)" <gi...@apache.org>.
NiklasMerz commented on code in PR #1319:
URL: https://github.com/apache/cordova-docs/pull/1319#discussion_r1211801821
##########
www/docs/en/dev/guide/appdev/security/index.md:
##########
@@ -42,7 +42,7 @@ By default the app's navigation is unrestricted. It's recommended to restrict th
## Iframes and the Callback Id Mechanism
-If content is served in an iframe from a whitelisted domain, that domain will have access to the native Cordova bridge. This means that if you whitelist a third-party advertising network and serve those ads through an iframe, it is possible that a malicious ad will be able to break out of the iframe and perform malicious actions. Because of this, you should generally not use iframes unless you control the server that hosts the iframe content. Also note that there are third party plugins available to support advertising networks. Note that this statement is not true for iOS, which intercepts everything including iframe connections.
+If content is served in an iframe from a allow listed domain, that domain will have access to the native Cordova bridge. This means that if you allowed a third-party advertising network and serve those ads through an iframe, it is possible that a malicious ad will be able to break out of the iframe and perform malicious actions. Because of this, you should generally not use iframes unless you control the server that hosts the iframe content. Also note that there are third party plugins available to support advertising networks. Note that this statement is not true for iOS, which intercepts everything including iframe connections.
Review Comment:
```suggestion
If content is served in an iframe from a allow listed domain, that domain will have access to the native Cordova bridge. This means that if you allow a third-party advertising network and serve those ads through an iframe, it is possible that a malicious ad will be able to break out of the iframe and perform malicious actions. Because of this, you should generally not use iframes unless you control the server that hosts the iframe content. Also note that there are third party plugins available to support advertising networks. Note that this statement is not true for iOS, which intercepts everything including iframe connections.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For additional commands, e-mail: issues-help@cordova.apache.org
[GitHub] [cordova-docs] NiklasMerz commented on a diff in pull request #1319: doc: various page improvements
Posted by "NiklasMerz (via GitHub)" <gi...@apache.org>.
NiklasMerz commented on code in PR #1319:
URL: https://github.com/apache/cordova-docs/pull/1319#discussion_r1211810532
##########
www/docs/en/dev/guide/platforms/ios/plugin.md:
##########
@@ -260,8 +260,8 @@ For JavaScript, you can attach Safari to the app running within the iOS Simulato
- Don't forget to add your plugin's mapping to `config.xml`. If you
forget, an error is logged in the Xcode console.
-- Don't forget to add any hosts you connect to in the whitelist, as
- described in Domain [Whitelist Guide](../../appdev/whitelist/index.html). If you forget, an error is
+- Don't forget to add any hosts you connect to in the allo list, as
Review Comment:
```suggestion
- Don't forget to add any hosts you connect to in the allow list, as
```
##########
www/docs/en/dev/guide/appdev/security/index.md:
##########
@@ -42,7 +42,7 @@ By default the app's navigation is unrestricted. It's recommended to restrict th
## Iframes and the Callback Id Mechanism
-If content is served in an iframe from a whitelisted domain, that domain will have access to the native Cordova bridge. This means that if you whitelist a third-party advertising network and serve those ads through an iframe, it is possible that a malicious ad will be able to break out of the iframe and perform malicious actions. Because of this, you should generally not use iframes unless you control the server that hosts the iframe content. Also note that there are third party plugins available to support advertising networks. Note that this statement is not true for iOS, which intercepts everything including iframe connections.
+If content is served in an iframe from a allow listed domain, that domain will have access to the native Cordova bridge. This means that if you allowed a third-party advertising network and serve those ads through an iframe, it is possible that a malicious ad will be able to break out of the iframe and perform malicious actions. Because of this, you should generally not use iframes unless you control the server that hosts the iframe content. Also note that there are third party plugins available to support advertising networks. Note that this statement is not true for iOS, which intercepts everything including iframe connections.
Review Comment:
```suggestion
If content is served in an iframe from a allow listed domain, that domain will have access to the native Cordova bridge. This means that if you allowe a third-party advertising network and serve those ads through an iframe, it is possible that a malicious ad will be able to break out of the iframe and perform malicious actions. Because of this, you should generally not use iframes unless you control the server that hosts the iframe content. Also note that there are third party plugins available to support advertising networks. Note that this statement is not true for iOS, which intercepts everything including iframe connections.
```
##########
www/docs/en/dev/guide/platforms/android/index.md:
##########
@@ -31,19 +31,119 @@ Regardless of whether you intend to utilize Android-specific command-line tools
The supported [Android API Levels](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) (versions of Android) corresponding with the Cordova-Android released versions are listed in the table below:
-cordova-android Version | Supported Android API-Levels | Equivalent Android Version
-------------------------|------------------------------|-----------------------------
-12.X.X | 24 - 33 | 7.0 - 13.0.0
-11.X.X | 22 - 32 | 5.1 - 12.0.0 (L)
-10.X.X | 22 - 30 | 5.1 - 11.0.0
-9.X.X | 22 - 29 | 5.1 - 10.0.0
-8.X.X | 19 - 28 | 4.4 - 9.0.0
-7.X.X | 19 - 27 | 4.4 - 8.1
-6.X.X | 16 - 26 | 4.1 - 8.0.0
-5.X.X | 14 - 23 | 4.0 - 6.0.1
-4.1.X | 14 - 22 | 4.0 - 5.1
-4.0.X | 10 - 22 | 2.3.3 - 5.1
-3.7.X | 10 - 21 | 2.3.3 - 5.0.2
+<table>
+ <thead>
+ <tr>
+ <th>cordova-android Version</th>
+ <th>Android API-Levels (Android Version)</th>
Review Comment:
Why replace the md table with a HTML table?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For additional commands, e-mail: issues-help@cordova.apache.org
[GitHub] [cordova-docs] erisu commented on a diff in pull request #1319: doc: various page improvements
Posted by "erisu (via GitHub)" <gi...@apache.org>.
erisu commented on code in PR #1319:
URL: https://github.com/apache/cordova-docs/pull/1319#discussion_r1211900641
##########
www/docs/en/dev/guide/platforms/android/index.md:
##########
@@ -31,19 +31,119 @@ Regardless of whether you intend to utilize Android-specific command-line tools
The supported [Android API Levels](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) (versions of Android) corresponding with the Cordova-Android released versions are listed in the table below:
-cordova-android Version | Supported Android API-Levels | Equivalent Android Version
-------------------------|------------------------------|-----------------------------
-12.X.X | 24 - 33 | 7.0 - 13.0.0
-11.X.X | 22 - 32 | 5.1 - 12.0.0 (L)
-10.X.X | 22 - 30 | 5.1 - 11.0.0
-9.X.X | 22 - 29 | 5.1 - 10.0.0
-8.X.X | 19 - 28 | 4.4 - 9.0.0
-7.X.X | 19 - 27 | 4.4 - 8.1
-6.X.X | 16 - 26 | 4.1 - 8.0.0
-5.X.X | 14 - 23 | 4.0 - 6.0.1
-4.1.X | 14 - 22 | 4.0 - 5.1
-4.0.X | 10 - 22 | 2.3.3 - 5.1
-3.7.X | 10 - 21 | 2.3.3 - 5.0.2
+<table>
+ <thead>
+ <tr>
+ <th>cordova-android Version</th>
+ <th>Android API-Levels (Android Version)</th>
Review Comment:
MD list and HTML list can not be render in the MD table. It appear it's not supported by the markdown engine that is used by Jekyll.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For additional commands, e-mail: issues-help@cordova.apache.org
[GitHub] [cordova-docs] erisu commented on a diff in pull request #1319: doc: various page improvements
Posted by "erisu (via GitHub)" <gi...@apache.org>.
erisu commented on code in PR #1319:
URL: https://github.com/apache/cordova-docs/pull/1319#discussion_r1212522678
##########
www/docs/en/dev/plugin_ref/spec.md:
##########
@@ -55,12 +55,12 @@ The child elements of the `<engines>` element specify versions of Apache Cordova
>is in a plugin's `package.json`. See [specifying Cordova dependencies](../guide/hybrid/plugins/index.html#specifying-cordova-dependencies)
>for more information
-Attributes(type) <br/> <span class="sub-header">Only for platform:</span> | Description
+Attributes | Description
---------------- | ------------
-name(string) | *Required* <br/> Name of the engine. Here are the default engines that are supported : <ul><li> `cordova` </li> <li> `cordova-plugman` </li> <li> `cordova-android` </li> <li> `cordova-browser` </li> <li> `cordova-ios` </li> <li> `cordova-windows` </li> <li> `cordova-osx` </li> <li> `windows-os` </li> <li> `android-sdk` (returns the highest Android api level installed) </li> <li> `windows-sdk` (returns the native windows SDK version) </li> <li> `apple-xcode` (returns the xcode version) </li> <li> `apple-ios` (returns the highest iOS version installed) </li> <li> `apple-osx` (returns the OSX version) </li> You can also specify a custom framework apart from the default ones.
-version(string) | *Required* <br/> The version that your framework must have in order to install. Semver syntax is supported.
-scriptSrc(string) | **For custom frameworks only** <br/> *Required* <br/> The script file that tells plugman the version of the custom framework. Ideally, this file should be within the top level directory of your plugin directory.
-platform(string) | **For custom frameworks only** <br/> *Required* <br/> The platforms your framework supports. You may use the wildcard `*` to say supported for all platforms, specify multiple with a pipe character like `android|ios` or just a single platform like `android`.
+name<br />{% cdv_vartype string %}| *Required* <br/>Name of the engine. Here are the default engines that are supported: <ul><li>`cordova`</li><li> `cordova-plugman`</li><li>`cordova-android`</li> <li>`cordova-browser`</li><li>`cordova-ios`</li><li>`windows-os`</li><li>`android-sdk` (returns the highest Android api level installed) </li><li> `apple-xcode` (returns the xcode version) </li><li>`apple-ios` (returns the highest iOS version installed)</li><li>`apple-osx` (returns the macOS version)</li></ul> You can also specify a custom framework apart from the default ones.
Review Comment:
```suggestion
name<br />{% cdv_vartype string %}| *Required* <br/>Name of the engine. Here are the default engines that are supported: `cordova`, `cordova-plugman`, `cordova-android`, `cordova-browser`, `cordova-ios`, `windows-os`, `android-sdk` (returns the highest Android api level installed) , `apple-xcode` (returns the xcode version), `apple-ios` (returns the highest iOS version installed), `apple-osx` (returns the macOS version). You can also specify a custom framework apart from the default ones.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For additional commands, e-mail: issues-help@cordova.apache.org