From 34715ff3a8db88ac7aade6c462dd68638ff9a357 Mon Sep 17 00:00:00 2001 From: Jonah Stiennon Date: Mon, 7 Jul 2014 17:53:30 -0700 Subject: [PATCH] doc cleanup --- docs/en/about-appium/intro.md | 2 +- docs/en/advanced-concepts/migrating-to-1-0.md | 2 +- docs/en/appium-setup/android-hax-emulator.md | 2 +- docs/en/appium-setup/ios-deploy.md | 2 +- docs/en/appium-setup/platform-support.md | 22 ++++++++----------- 5 files changed, 13 insertions(+), 17 deletions(-) diff --git a/docs/en/about-appium/intro.md b/docs/en/about-appium/intro.md index 354be5103a6..f93146654c5 100644 --- a/docs/en/about-appium/intro.md +++ b/docs/en/about-appium/intro.md @@ -3,7 +3,7 @@ Appium is an open-source tool for automating native, mobile web, and hybrid applications on iOS and Android platforms. **Native apps** are those written using the iOS or Android SDKs. **Mobile web apps** are web apps accessed using a mobile browser (Appium supports -Safari on iOS and Chrome on Android). **Hybrid apps** have a +Safari on iOS and Chrome or the built-in 'Browser' app on Android). **Hybrid apps** have a wrapper around a "webview" -- a native control that enables interaction with web content. Projects like [Phonegap](http://phonegap.com/), make it easy to build apps using web technologies that are then bundled into diff --git a/docs/en/advanced-concepts/migrating-to-1-0.md b/docs/en/advanced-concepts/migrating-to-1-0.md index 38230469a89..0ab7e8f380e 100644 --- a/docs/en/advanced-concepts/migrating-to-1-0.md +++ b/docs/en/advanced-concepts/migrating-to-1-0.md @@ -4,7 +4,7 @@ Appium 1.0 has removed a number of deprecated features from the previous version ### New client libraries -The biggest thing you need to worry about is using the new Appium client libraries instead of the vanilla WebDriver clients you are currently using. Visit the [Appium client list](appium-clients.md) to find the client for your language. Downloads and instructions for integrating into your code are available on the individual client websites. +The biggest thing you need to worry about is using the new Appium client libraries instead of the vanilla WebDriver clients you are currently using. Visit the [Appium client list](/docs/en/about-appium/appium-clients.md) to find the client for your language. Downloads and instructions for integrating into your code are available on the individual client websites. Ultimately, you'll be doing something like (to use Python as an example): diff --git a/docs/en/appium-setup/android-hax-emulator.md b/docs/en/appium-setup/android-hax-emulator.md index 1faa07cdae4..3c596944280 100644 --- a/docs/en/appium-setup/android-hax-emulator.md +++ b/docs/en/appium-setup/android-hax-emulator.md @@ -2,7 +2,7 @@ If you find the android emulator a slow and your system runs on an Intel® cpu, you can check out HAXM. HAXM let's you leverage your hardware for -virtualization accelerating the emulator. +virtualization, accelerating the emulator. * To install HAXM open the Android SDK Manager, you will find the package under Extras. diff --git a/docs/en/appium-setup/ios-deploy.md b/docs/en/appium-setup/ios-deploy.md index 4e61cd16e38..469e5507aa8 100644 --- a/docs/en/appium-setup/ios-deploy.md +++ b/docs/en/appium-setup/ios-deploy.md @@ -1,4 +1,4 @@ -## Deploying your iOS app to your device +## Deploying an iOS app to a real device To prepare for your Appium tests to run on a real device, you will need to: diff --git a/docs/en/appium-setup/platform-support.md b/docs/en/appium-setup/platform-support.md index 6fa8540451b..45bbc3db9e8 100644 --- a/docs/en/appium-setup/platform-support.md +++ b/docs/en/appium-setup/platform-support.md @@ -9,7 +9,7 @@ make explicit the level of support and requirements for each of these. See [Running on OS X: iOS](running-on-osx.md) for iOS requirements and setup instructions. -* Versions: 6.1, 7.0, and 7.1 +* Versions: 6.0, 6.1, 7.0, and 7.1 * Devices: iPhone Simulator, iPad Simulator, and real iPhones and iPads * Native app support: Yes, with debug version of .app (simulator), or correctly-signed .ipa (real devices). Underlying support is provided by @@ -17,9 +17,9 @@ instructions. framework. * Mobile web support: Yes, via automation of mobile Safari. For real devices, ios-webkit-remote-debugger is required, and automation of native aspects of - the Safari interface is not possible. See the [mobile web doc](mobile-web.md) for instructions. + the Safari interface is not possible. See the [mobile web doc](/docs/en/writing-running-appium/mobile-web.md) for instructions. * Hybrid support: Yes. For real devices, ios-webkit-remote-debugger is - required. See the [hybrid doc](hybrid.md) for instructions. + required. See the [hybrid doc](/docs/en/advanced-concepts/hybrid.md) for instructions. * Support for automating multiple apps in one session: No * Support for automating multiple devices simultaneously: No * Support for automating vendor-provided or third-party apps: Only @@ -36,14 +36,10 @@ See [Running on OS X: Android](running-on-osx.md), instructions. * Versions: 2.3 and up + * Versions 2.3 through 4.2 are supported via Appium's bundled version of + [Selendroid](http://selendroid.io), which utilizes [Instrumentation](http://developer.android.com/reference/android/app/Instrumentation.html). Selendroid has a different set of commands than the default Appium (though this is rapidly being minimized) and a different support profile. To access this automation backend, use the `automationName` capability with the value `Selendroid`. * Versions 4.2 and up are supported via Appium's own [UiAutomator](http://developer.android.com/tools/help/uiautomator/index.html) - libraries. This is the default automation backend. - * Versions 2.3 through 4.3 are supported via Appium's bundled version of - [Selendroid](http://selendroid.io), which utilizes [Instrumentation](http://developer.android.com/reference/android/app/Instrumentation.html). - Selendroid has a different set of commands than the default Appium (though - this is rapidly being minimized) and a different support profile. To - access this automation backend, use the `automationName` capability with - the value `Selendroid`. + libraries. This is the default automation backend. * Devices: Android emulators and real Android devices * Native app support: Yes * Mobile web support: Yes (but not when using Selendroid backend). Automation @@ -51,8 +47,8 @@ instructions. server as a proxy. With 4.2 and 4.3, automation works on official Chrome browser or Chromium only. With 4.4+, automation also works on the built-in "Browser" app. Chrome/Chromium/Browser must already be installed on the - device under test. See the [mobile web doc](mobile-web.md) for instructions. -* Hybrid support: Yes. See the [hybrid doc](hybrid.md) for instructions. + device under test. See the [mobile web doc](/docs/en/writing-running-appium/mobile-web.md) for instructions. +* Hybrid support: Yes. See the [hybrid doc](docs/en/advanced-concepts/hybrid.md) for instructions. * With default Appium automation backend: versions 4.4 and up * With Selendroid automation backend: versions 2.3 and up * Support for automating multiple apps in one session: Yes (but not when @@ -60,7 +56,7 @@ instructions. * Support for automating multiple devices simultaneously: Yes, though Appium must be started using different ports for the server parameters `--port`, `--bootstrap-port` (or `--selendroid-port`) and/or - `--chromedriver-port`. See the [server args doc](server-args.md) for more + `--chromedriver-port`. See the [server args doc](/docs/en/writing-running-appium/server-args.md) for more information on these parameters. * Support for automating vendor-provided or third-party apps: Yes (but not when using the Selendroid backend)