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/24 11:13:52 UTC
[GitHub] [cordova-docs] erisu opened a new pull request, #1313: doc(guide): refactor and improve Create your first Cordova app
erisu opened a new pull request, #1313:
URL: https://github.com/apache/cordova-docs/pull/1313
### 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. -->
Refactor the entire create first app guide
### Description
<!-- Describe your changes in detail -->
- Formatting
- Wording
- Remove `sudo` usage but still keep a small snippt explaining when it might be needed and what is recommended.
### Testing
<!-- Please describe in detail how you tested your changes. -->
n/a
### Checklist
- [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 commented on a diff in pull request #1313: doc(guide): refactor and improve Create your first Cordova app
Posted by "erisu (via GitHub)" <gi...@apache.org>.
erisu commented on code in PR #1313:
URL: https://github.com/apache/cordova-docs/pull/1313#discussion_r1204055195
##########
www/docs/en/dev/guide/cli/index.md:
##########
@@ -133,86 +120,78 @@ Android target: installed android-19,android-21,android-22,android-23,Google Inc
Gradle: installed
Requirements check results for ios:
-Apple OS X: not installed
-Cordova tooling for iOS requires Apple OS X
+Apple macOS: not installed
+Cordova tooling for iOS requires Apple macOS
Error: Some of requirements check failed
```
-### See Also
+**See Also:**
+
- [Android platform requirements](../../guide/platforms/android/index.html#requirements-and-support)
- [iOS platform requirements](../../guide/platforms/ios/index.html#requirements-and-support)
- [Windows platform requirements](../../guide/platforms/windows/index.html#requirements-and-support)
## Build the App
-By default, `cordova create` script generates a skeletal web-based application whose start page is the project's `www/index.html` file. Any
-initialization should be specified as part of the [deviceready][DeviceReadyEvent] event handler defined in `www/js/index.js`.
+By default, `cordova create` script generates a skeletal web-based application whose start page is the project's `www/index.html` file. Any initialization should be specified as part of the [deviceready][DeviceReadyEvent] event handler defined in `www/js/index.js`.
Run the following command to build the project for _all_ platforms:
```bash
-$ cordova build
+cordova build
```
You can optionally limit the scope of each build to specific platforms - 'ios' in this case:
```bash
-$ cordova build ios
+cordova build ios
```
-### See Also
+**See Also:**
+
- [Cordova build command reference documentation][cdv_build]
## Test the App
-SDKs for mobile platforms often come bundled with emulators that
-execute a device image, so that you can launch the app from the home
-screen and see how it interacts with many platform features. Run a
-command such as the following to rebuild the app and view it within a
-specific platform's emulator:
+SDKs for mobile platforms often come bundled with emulators that execute a device image, so that you can launch the app from the home screen and see how it interacts with many platform features. Run a command such as the following to rebuild the app and view it within a specific platform's emulator:
```bash
-$ cordova emulate android
+cordova emulate android
```
-Following up with the `cordova emulate` command refreshes the emulator
-image to display the latest application, which is now available for
-launch from the home screen:
+Following up with the `cordova emulate` command refreshes the emulator image to display the latest application, which is now available for launch from the home screen:
-Alternately, you can plug the handset into your computer and test the
-app directly:
+Alternately, you can plug the handset into your computer and test the app directly:
```bash
-$ cordova run android
+cordova run android
```
-Before running this command, you need to set up the device for
-testing, following procedures that vary for each platform.
+Before running this command, you need to set up the device for testing, following procedures that vary for each platform.
+
+**See Also:**
-### See Also
- [Setting up Android emulator](../../guide/platforms/android/index.html#setting-up-an-emulator)
- [Cordova run command reference documentation][cdv_run]
- [Cordova emulate command reference documentation][cdv_emulate]
## Add Plugins
-You can modify the default generated app to take advantage of standard web technologies,
-but for the app to access device-level features, you need to add plugins.
+You can modify the default generated app to take advantage of standard web technologies, but for the app to access device-level features, you need to add plugins.
-A _plugin_ exposes a Javascript API for native SDK functionality. Plugins are typically hosted on
-npm and you can search for them on the [plugin search page](/plugins/). Some key APIs are provided by the Apache Cordova open source project and these are referred to as [Core Plugin APIs]. You can also use the CLI to launch the search page:
+A _plugin_ exposes a Javascript API for native SDK functionality. Plugins are typically hosted on npm and you can search for them on the [plugin search page](/plugins/). Some key APIs are provided by the Apache Cordova open source project and these are referred to as [Core Plugin APIs]. You can also use the CLI to launch the search page:
```bash
-$ cordova plugin search camera
+cordova plugin search camera
Review Comment:
Removed.
--
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 #1313: doc(guide): refactor and improve Create your first Cordova app
Posted by "erisu (via GitHub)" <gi...@apache.org>.
erisu merged PR #1313:
URL: https://github.com/apache/cordova-docs/pull/1313
--
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] breautek commented on a diff in pull request #1313: doc(guide): refactor and improve Create your first Cordova app
Posted by "breautek (via GitHub)" <gi...@apache.org>.
breautek commented on code in PR #1313:
URL: https://github.com/apache/cordova-docs/pull/1313#discussion_r1203990588
##########
www/docs/en/dev/guide/cli/index.md:
##########
@@ -133,86 +120,78 @@ Android target: installed android-19,android-21,android-22,android-23,Google Inc
Gradle: installed
Requirements check results for ios:
-Apple OS X: not installed
-Cordova tooling for iOS requires Apple OS X
+Apple macOS: not installed
+Cordova tooling for iOS requires Apple macOS
Error: Some of requirements check failed
```
-### See Also
+**See Also:**
+
- [Android platform requirements](../../guide/platforms/android/index.html#requirements-and-support)
- [iOS platform requirements](../../guide/platforms/ios/index.html#requirements-and-support)
- [Windows platform requirements](../../guide/platforms/windows/index.html#requirements-and-support)
## Build the App
-By default, `cordova create` script generates a skeletal web-based application whose start page is the project's `www/index.html` file. Any
-initialization should be specified as part of the [deviceready][DeviceReadyEvent] event handler defined in `www/js/index.js`.
+By default, `cordova create` script generates a skeletal web-based application whose start page is the project's `www/index.html` file. Any initialization should be specified as part of the [deviceready][DeviceReadyEvent] event handler defined in `www/js/index.js`.
Run the following command to build the project for _all_ platforms:
```bash
-$ cordova build
+cordova build
```
You can optionally limit the scope of each build to specific platforms - 'ios' in this case:
```bash
-$ cordova build ios
+cordova build ios
```
-### See Also
+**See Also:**
+
- [Cordova build command reference documentation][cdv_build]
## Test the App
-SDKs for mobile platforms often come bundled with emulators that
-execute a device image, so that you can launch the app from the home
-screen and see how it interacts with many platform features. Run a
-command such as the following to rebuild the app and view it within a
-specific platform's emulator:
+SDKs for mobile platforms often come bundled with emulators that execute a device image, so that you can launch the app from the home screen and see how it interacts with many platform features. Run a command such as the following to rebuild the app and view it within a specific platform's emulator:
```bash
-$ cordova emulate android
+cordova emulate android
```
-Following up with the `cordova emulate` command refreshes the emulator
-image to display the latest application, which is now available for
-launch from the home screen:
+Following up with the `cordova emulate` command refreshes the emulator image to display the latest application, which is now available for launch from the home screen:
-Alternately, you can plug the handset into your computer and test the
-app directly:
+Alternately, you can plug the handset into your computer and test the app directly:
```bash
-$ cordova run android
+cordova run android
```
-Before running this command, you need to set up the device for
-testing, following procedures that vary for each platform.
+Before running this command, you need to set up the device for testing, following procedures that vary for each platform.
+
+**See Also:**
-### See Also
- [Setting up Android emulator](../../guide/platforms/android/index.html#setting-up-an-emulator)
- [Cordova run command reference documentation][cdv_run]
- [Cordova emulate command reference documentation][cdv_emulate]
## Add Plugins
-You can modify the default generated app to take advantage of standard web technologies,
-but for the app to access device-level features, you need to add plugins.
+You can modify the default generated app to take advantage of standard web technologies, but for the app to access device-level features, you need to add plugins.
-A _plugin_ exposes a Javascript API for native SDK functionality. Plugins are typically hosted on
-npm and you can search for them on the [plugin search page](/plugins/). Some key APIs are provided by the Apache Cordova open source project and these are referred to as [Core Plugin APIs]. You can also use the CLI to launch the search page:
+A _plugin_ exposes a Javascript API for native SDK functionality. Plugins are typically hosted on npm and you can search for them on the [plugin search page](/plugins/). Some key APIs are provided by the Apache Cordova open source project and these are referred to as [Core Plugin APIs]. You can also use the CLI to launch the search page:
```bash
-$ cordova plugin search camera
+cordova plugin search camera
Review Comment:
I don't think this feature exists anymore.
1. the command requires to be inside a cordova project
2. this is what it does for me:
```
cordova plugin search cordova-plugin-camera
@totalpave/cdv-iri-log 0.0.0 "cdv-iri-log"
@totalpave/cordova-plugin-device-motion 1.0.2 "Device Motion"
@totalpave/cordova-plugin-file 1.0.1 "File"
@totalpave/cordova-plugin-geolocation 1.0.1 "Geolocation"
@totalpave/cordova-plugin-insets 0.1.6 "cordova-plugin-insets"
@totalpave/cordova-plugin-libcxx 25.0.8775105 "libc++_shared.so"
@totalpave/cordova-plugin-libsqlite 0.0.16 "SQLite Binaries v3.39.2"
@totalpave/cordova-plugin-libtilegen 0.0.6 "libtilegen"
@totalpave/cordova-plugin-sqlite 0.0.1 "SQLite 3.39.2"
cordova-plugin-androidx-adapter 1.1.3 "cordova-plugin-androidx-adapter"
cordova-plugin-buildinfo 4.0.0 "BuildInfo"
cordova-plugin-crosswalk-data-migration 1.0.0 "Crosswalk Data Migration Plugin"
cordova-plugin-device 2.1.0 "Device"
cordova-plugin-dialogs 2.0.2 "Notification"
cordova-plugin-disable-ios11-statusbar 1.0.0 "cordova-plugin-disable-ios11-statusbar"
cordova-plugin-googlemaps 3.0.4 "cordova-plugin-googlemaps"
cordova-plugin-insomnia 4.3.0 "Insomnia (prevent screen sleep)"
cordova-plugin-ionic-webview 5.0.0 "cordova-plugin-ionic-webview"
cordova-plugin-localization-strings 4.2.0 "Localization"
cordova-plugin-migrate-localstorage 0.0.3 "Migrate WebView Data"
cordova-plugin-screen-orientation 3.0.2 "Screen Orientation"
cordova-plugin-statusbar 1.3.1 "StatusBar"
cordova.plugins.diagnostic 6.1.0 "Diagnostic"
es6-promise-plugin 4.2.2 "Promise"
```
--
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