Fix broken links (#9542)

This commit is contained in:
Dan Graham
2017-10-30 16:08:29 -07:00
committed by GitHub
parent 433a453903
commit 3ec103fb23
26 changed files with 31 additions and 28 deletions

View File

@@ -28,7 +28,7 @@ example_usage:
// TODO C# sample
client_docs:
java: "http://appium.github.io/java-client/io/appium/java_client/android/UnlocksAndroidDevice.html#unlockDevice--"
java: "http://appium.github.io/java-client/io/appium/java_client/android/LocksAndroidDevice.html#unlockDevice---"
javascript_wdio: "http://webdriver.io/api/mobile/unlock.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2386"
php: "https://github.com/appium/php-client/" # TODO PHP documentation link

View File

@@ -7,7 +7,7 @@ description:
must be [enrolled](https://support.apple.com/en-ca/ht201371).
When you set `allowTouchIdEnroll` to true, it will set the Simulator to be enrolled by default.
The enrollment state can be [toggled](/docs/en/commands/device/simulator/toggle-touch-id-enrollment)
The enrollment state can be [toggled](/docs/en/commands/device/simulator/toggle-touch-id-enrollment.md)
This call will only work if Appium process or its parent application (e.g. Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list

View File

@@ -5,7 +5,7 @@ description:
>
Any UTF-8 character may be specified, however, if the server does not support native key events, it should simulate key strokes for a standard US keyboard layout. The Unicode Private Use Area code points, 0xE000-0xF8FF, are used to represent pressable, non-text keys (see table below).
(See [Unicode document](/docs/en/writing-running-appium/unicode.md) for information on Unicode characters)
(See [Unicode document](/docs/en/writing-running-appium/other/unicode.md) for information on Unicode characters)
example_usage:
java:

View File

@@ -3,7 +3,7 @@ name: Find Elements
short_description: Search for multiple elements
description:
>
Get a list of elements that match the [locator selector](/docs/en/about-appium/getting-started).
Get a list of elements that match the [locator selector](/docs/en/about-appium/getting-started.md).
selector_strategies:
- name: Accessibility ID
description: Read a unique identifier for a UI element. For XCUITest it is the element's `resource-id` attribute. For Android it is the element's `content-desc` attribute.

View File

@@ -1,6 +1,6 @@
---
name: Set Script Timeout
short_description: Set the amount of time, in milliseconds, that asynchronous scripts executed by [execute async](/docs/en/commands/session/execute-async.md) are permitted to run before they are aborted (Web context only)
short_description: Set the amount of time, in milliseconds, that asynchronous scripts executed by [execute async](/docs/en/commands/session/timeouts/async-script.md) are permitted to run before they are aborted (Web context only)
example_usage:
java:

View File

@@ -4,7 +4,7 @@ short_description: Configure the amount of time that a particular type of operat
description:
|
The types of timeouts are 'page load', ['script'](/docs/en/commands/session/async-script.md) and ['implicit'](/docs/en/commands/session/implicit.md). (The example usage is just 'page load')
The types of timeouts are 'page load', ['script'](/docs/en/commands/session/timeouts/async-script.md) and ['implicit'](/docs/en/commands/session/timeouts/implicit-wait.md). (The example usage is just 'page load')
example_usage:
java:

View File

@@ -30,7 +30,7 @@ example_usage:
// TODO
client_docs:
java: "https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/" # TODO
# java: "https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/" # TODO
python: "http://selenium-python.readthedocs.io/api.html#selenium.webdriver.common.utils.is_url_connectable"
javascript_wdio: "http://webdriver.io/api/protocol/status.html"
javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L44"

View File

@@ -7,7 +7,7 @@
* 这需要 x86 架构的模拟器镜像;
* 使用 Intel 的安装包去安装 HAXM; 根据你已经安装过的版本不同Android SDK Manager 可能会安装不成功(译者注:如果原来已经有一个旧版本,此时有可能会自动安装失败。建议在 [Intel® 的网站][1] 安装官方安装包手动安装)。
[1]: http://software.intel.com/en-us/articles/intel-hardware-accelerated-execution-manager/
[1]: https://software.intel.com/en-us/articles/intel-hardware-accelerated-execution-manager-intel-haxm
翻译 by [thanksdanny](https://github.com/thanksdanny) ,由 [chenhengjie123](https://github.com/chenhengjie123) 校验

View File

@@ -17,7 +17,7 @@ code reuse between iOS, Android, and Windows testsuites.
For specific information about what it means for Appium to "support" its
platforms, and automation modalities, please see the [platform support
doc](/docs/en/appium-setup/platform-support.md).
doc](/docs/en/about-appium/platform-support.md).
### Appium Philosophy

View File

@@ -66,7 +66,7 @@ await driver.unlock();
|Language|Support|Documentation|
|--------|-------|-------------|
|[Java](https://github.com/appium/java-client/releases/latest)| All | [appium.github.io](http://appium.github.io/java-client/io/appium/java_client/android/UnlocksAndroidDevice.html#unlockDevice--) |
|[Java](https://github.com/appium/java-client/releases/latest)| All | [appium.github.io](http://appium.github.io/java-client/io/appium/java_client/android/LocksAndroidDevice.html#unlockDevice---) |
|[Python](https://github.com/appium/python-client/releases/latest)| All | |
|[Javascript (WebdriverIO)](http://webdriver.io/index.html)| All | [webdriver.io](http://webdriver.io/api/mobile/unlock.html) |
|[Javascript (WD)](https://github.com/admc/wd/releases/latest)| All | [github.com](https://github.com/admc/wd/blob/master/lib/commands.js#L2386) |

View File

@@ -57,7 +57,7 @@ To enable this feature, the `allowTouchIdEnroll` desired capability must be set
must be [enrolled](https://support.apple.com/en-ca/ht201371).
When you set `allowTouchIdEnroll` to true, it will set the Simulator to be enrolled by default.
The enrollment state can be [toggled](/docs/en/commands/device/simulator/toggle-touch-id-enrollment)
The enrollment state can be [toggled](/docs/en/commands/device/simulator/toggle-touch-id-enrollment.md)
This call will only work if Appium process or its parent application (e.g. Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list

View File

@@ -51,7 +51,7 @@ await element.type("Hello world!")
## Description
Any UTF-8 character may be specified, however, if the server does not support native key events, it should simulate key strokes for a standard US keyboard layout. The Unicode Private Use Area code points, 0xE000-0xF8FF, are used to represent pressable, non-text keys (see table below).
(See [Unicode document](/docs/en/writing-running-appium/unicode.md) for information on Unicode characters)
(See [Unicode document](/docs/en/writing-running-appium/other/unicode.md) for information on Unicode characters)
## Support

View File

@@ -60,7 +60,7 @@ let elementsTwo = await driver.elements("id", "SomeID");
## Description
Get a list of elements that match the [locator selector](/docs/en/about-appium/getting-started).
Get a list of elements that match the [locator selector](/docs/en/about-appium/getting-started.md).
## Support

View File

@@ -1,6 +1,6 @@
# Set Script Timeout
Set the amount of time, in milliseconds, that asynchronous scripts executed by [execute async](/docs/en/commands/session/execute-async.md) are permitted to run before they are aborted (Web context only)
Set the amount of time, in milliseconds, that asynchronous scripts executed by [execute async](/docs/en/commands/session/timeouts/async-script.md) are permitted to run before they are aborted (Web context only)
## Example Usage
```java

View File

@@ -48,7 +48,7 @@ await driver.setPageLoadTimeout(5000);
## Description
The types of timeouts are 'page load', ['script'](/docs/en/commands/session/async-script.md) and ['implicit'](/docs/en/commands/session/implicit.md). (The example usage is just 'page load')
The types of timeouts are 'page load', ['script'](/docs/en/commands/session/timeouts/async-script.md) and ['implicit'](/docs/en/commands/session/timeouts/implicit-wait.md). (The example usage is just 'page load')
## Support

View File

@@ -71,7 +71,7 @@ Implementations may optionally include additional meta information as part of th
|Language|Support|Documentation|
|--------|-------|-------------|
|[Java](https://github.com/appium/java-client/releases/latest)| All | [seleniumhq.github.io](https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/) |
|[Java](https://github.com/appium/java-client/releases/latest)| All | |
|[Python](https://github.com/appium/python-client/releases/latest)| All | [selenium-python.readthedocs.io](http://selenium-python.readthedocs.io/api.html#selenium.webdriver.common.utils.is_url_connectable) |
|[Javascript (WebdriverIO)](http://webdriver.io/index.html)| All | [webdriver.io](http://webdriver.io/api/protocol/status.html) |
|[Javascript (WD)](https://github.com/admc/wd/releases/latest)| All | [github.com](https://github.com/admc/wd/blob/master/lib/commands.js#L44) |

View File

@@ -3,7 +3,7 @@
Before reading this document, please ensure that you have read and understood
the more general [introduction to Appium
concepts](/docs/en/about-appium/intro.md) and the more general [contribution
instructions](/CONTRIBUTING.md).
instructions](https://github.com/appium/appium/blob/master/CONTRIBUTING.md).
### Technical Vision

View File

@@ -33,7 +33,7 @@ Link to another document
### Writing Commands Documents
The [command documents](/docs/en/commands) located in `docs/en/commands`, are generated
The command documents located in `docs/en/commands`, are generated
docs and aren't meant to be edited directly. The command documentation is defined in
`commands-yml/commands`.

View File

@@ -120,7 +120,7 @@ Additional tips for emulators:
* There exists a hardware accelerated emulator for Android, though it has its
own limitations. It can be installed from Intel's website, or through the
Android SDK Manager. For more information, go
[here](http://software.intel.com/en-us/articles/intel-hardware-accelerated-execution-manager/).
[here](https://software.intel.com/en-us/articles/intel-hardware-accelerated-execution-manager-intel-haxm).
* Make sure that `hw.battery=yes` in your AVD's `config.ini`, if you want to
run any of the Appium tests, or use any of the power commands. (As of Android
5.0, this is the default.)

View File

@@ -36,7 +36,7 @@ In addition to Appium's general requirements:
If you are migrating to the XCUITest driver from Appium's old
[UIAutomation-based driver](/docs/en/drivers/ios-uiautomation.md), you may wish
to consult this [migration
guide](/docs/en/advanced-concepts/migrating-to-1-0.md).
guide](/docs/en/advanced-concepts/migrating-to-xcuitest.md).
### Usage

View File

@@ -47,8 +47,8 @@ These Capabilities span multiple drivers.
|`udid`| Unique device identifier of the connected physical device|e.g. `1ae203187fc012g`|
|`orientation`| (Sim/Emu-only) start in a certain orientation|`LANDSCAPE` or `PORTRAIT`|
|`autoWebview`| Move directly into Webview context. Default `false`|`true`, `false`|
|`noReset`| Don't reset app state before this session. See [here](/docs/en/writing-running-appium/reset-strategies.md) for more details |`true`, `false`|
|`fullReset`| Perform a complete reset. See [here](/docs/en/writing-running-appium/reset-strategies.md) for more details |`true`, `false`|
|`noReset`| Don't reset app state before this session. See [here](/docs/en/writing-running-appium/other/reset-strategies.md) for more details |`true`, `false`|
|`fullReset`| Perform a complete reset. See [here](/docs/en/writing-running-appium/other/reset-strategies.md) for more details |`true`, `false`|
|`eventTimings`|Enable or disable the reporting of the timings for various Appium-internal events (e.g., the start and end of each command, etc.). Defaults to `false`. To enable, use `true`. The timings are then reported as `events` property on response to querying the current session. See the [event timing docs](/docs/en/advanced-concepts/event-timings.md) for the the structure of this response.|e.g., `true`|
|`enablePerformanceLogging`| (Web and webview only) Enable Chromedriver's (on Android) or Safari's (on iOS) performance logging (default `false`)| `true`, `false`|

View File

@@ -9,9 +9,9 @@ with certain constraints)
Appium additionally supports some of the [Mobile JSON Wire Protocol](https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md) locator strategies
* `-ios uiautomation`: a string corresponding to a recursive element search
using the [UIAutomation library](ios-predicate.md) (iOS 9.3 and below only)
using the [UIAutomation library](/docs/en/writing-running-appium/ios/ios-predicate.md) (iOS 9.3 and below only)
* `-android uiautomator`: a string corresponding to a recursive element
search using the [UiAutomator Api](uiautomator-uiselector.md) (Android-only)
search using the [UiAutomator Api](/docs/en/writing-running-appium/android/uiautomator-uiselector.md) (Android-only)
* `accessibility id`: a string corresponding to a recursive element search
using the Id/Name that the native Accessibility options utilize.

View File

@@ -5,7 +5,7 @@ to github or write to the [appium-discuss discussion group](https://discuss.appi
### General
* Make sure you've followed the getting started steps in the [README](/README.md)
* Make sure you've followed the getting started steps in the [README](https://github.com/appium/appium/blob/master/README.md)
* Make sure your system is set up appropriately (i.e., XCode is updated,
Android SDK is installed and `ANDROID_HOME` is set.
* Make sure the paths to your applications are correct

View File

@@ -192,7 +192,7 @@ directly. Therefore the connection has to be established through the USB cable.
To establish this connection we use the [ios-webkit-debugger-proxy](https://github.com/google/ios-webkit-debug-proxy).
For instruction on how to install and run `ios-webkit-debugger-proxy` see the
[iOS webkit debug proxy](/docs/en/writing-running-appium/ios-webkit-debug-proxy.md)
[iOS webkit debug proxy](/writing-running-appium/web/ios-webkit-debug-proxy.md)
documentation.
Now you can start an Appium test session and follow the generalized instructions

View File

@@ -9,7 +9,7 @@ capabilities.
### iOS mobile web automation
Appium can automate the Safari browser on real and simulated iOS devices. It is
accessed by setting the `browserName` [desired capabilty]((/docs/en/writing-running-appium/caps.md))
accessed by setting the `browserName` [desired capabilty](/docs/en/writing-running-appium/caps.md)
to `"Safari"` while leaving the `app` capability empty.
You **must** run Safari on the device before attempting to use Appium, in order
@@ -182,7 +182,7 @@ Pre-requisites:
device. See [here](/docs/en/writing-running-appium/web/chromedriver.md) for more
information and details about compatibility.
Then, use [desired capabilties]((/docs/en/writing-running-appium/caps.md)) like
Then, use [desired capabilties](/docs/en/writing-running-appium/caps.md) like
these to run your test in Chrome:
```javascript

View File

@@ -4,10 +4,13 @@ module.exports = {
["About", ["about-appium",
["Introduction", "intro.md"],
["The Appium Clients", "appium-clients.md"],
["Getting Started", "getting-started.md"],
["Supported Platforms", "platform-support.md"]]],
["Drivers", ["drivers",
["XCUITest (iOS)", "ios-xcuitest.md"],
["XCUITest Real Devices (iOS)", "ios-xcuitest-real-devices.md"],
["UIAutomation (iOS)", "ios-uiautomation.md"],
["UIAutomation Safari Launcher (iOS)", "ios-uiautomation-safari-launcher.md"],
["UIAutomator (Android)", "android-uiautomator.md"],
["UIAutomator2 (Android)", "android-uiautomator2.md"],
["Espresso (Android)", "android-espresso.md"],