Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix links in the documents #1140

Merged
merged 1 commit into from
May 6, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Please provide more details, if necessary.
## Code To Reproduce Issue [ Good To Have ]

Please remember that, with sample code; it's easier to reproduce bug and much faster to fix it.
You can git clone https://github.com/appium/sample-code or https://github.com/appium/sample-code/tree/master/sample-code/apps and reproduce an issue using Java and sample apps.
You can git clone https://github.com/appium/appium/tree/master/sample-code or https://github.com/appium/appium/tree/master/sample-code/apps and reproduce an issue using Java and sample apps.
Also you can create a [gist](https://gist.github.com) with pasted java code sample or put it here using markdown. About markdown please read [Mastering markdown](https://guides.github.com/features/mastering-markdown/) and
[Writing on GitHub](https://help.github.com/categories/writing-on-github/)

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# java-client

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.appium/java-client/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.appium/java-client)
[![Javadoc](https://www.javadoc.io/badge/io.appium/java-client.svg)](http://www.javadoc.io/doc/io.appium/java-client)
[![Javadocs](https://www.javadoc.io/badge/io.appium/java-client.svg)](https://www.javadoc.io/doc/io.appium/java-client)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/f365c5e9458b42bf8a5b1d928d7e4f48)](https://www.codacy.com/app/appium/java-client)
[![Build Status](https://travis-ci.org/appium/java-client.svg?branch=master)](https://travis-ci.org/appium/java-client)

This is the Java language binding for writing Appium Tests, conforms to [Mobile JSON Wire Protocol](https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md)

[API docs](http://appium.github.io/java-client/)
[API docs](https://www.javadoc.io/doc/io.appium/java-client)

### Features and other interesting information

Expand Down
2 changes: 1 addition & 1 deletion docs/How-to-report-an-issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ If it is necessary there should provided more details
### Code To Reproduce Issue (good to Have if you report a bug)

It's easier to reproduce bug and much faster to fix it.
You can git clone https://github.com/appium/sample-code or https://github.com/appium/sample-code/tree/master/sample-code/apps and reproduce an issue using Java and sample apps.
You can git clone https://github.com/appium/appium/tree/master/sample-code or https://github.com/appium/appium/tree/master/sample-code/apps and reproduce an issue using Java and sample apps.
Also you can create a [gist](https://gist.github.com) with pasted java code sample or paste it at ussue description using markdown. About markdown please read [Mastering markdown](https://guides.github.com/features/mastering-markdown/) and
[Writing on GitHub](https://help.github.com/categories/writing-on-github/)

Expand Down
2 changes: 1 addition & 1 deletion docs/Installing-the-project.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Requirements

Firstly you should install appium server. [Appium getting started](http://appium.io/docs/en/about-appium/getting-started/index.html). The latest server version is recommended.
Firstly you should install appium server. [Appium getting started](https://appium.io/docs/en/about-appium/getting-started/). The latest server version is recommended.

Since version 5.x there many features based on Java 8. So we recommend to install JDK SE 8 and provide that source compatibility.

Expand Down
2 changes: 1 addition & 1 deletion docs/Note-for-developers.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Please check following settings:

## Coding Standards

Appium java-client strictly follows [Google Java Style](http://google-styleguide.googlecode.com/svn/trunk/javaguide.html) as a coding standards. Contributors are requested to follow this by configuring in their IDE's Editor Code style,
Appium java-client strictly follows [Google Java Style](https://google.github.io/styleguide/javaguide.html) as a coding standards. Contributors are requested to follow this by configuring in their IDE's Editor Code style,

* Clone [Google Style Guide](https://github.com/google/styleguide.git) from git

Expand Down
2 changes: 1 addition & 1 deletion docs/Page-objects.md
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ List<RemoteWebElement> someElements;
# The additional feature.

## The simple example
Let's imagine that the task is to check an Android client of the [http://www.rottentomatoes.com](http://www.rottentomatoes.com/). Let it be like a picture below
Let's imagine that the task is to check an Android client of the [https://www.rottentomatoes.com](https://www.rottentomatoes.com/). Let it be like a picture below

![](https://cloud.githubusercontent.com/assets/4927589/11120641/51c1fda8-8962-11e5-8b17-323b5f236fce.png) Lets imagine that it is only a part of the screen.

Expand Down
2 changes: 1 addition & 1 deletion docs/Tech-stack.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This project is based on [Selenium java client](https://github.com/SeleniumHQ/se

This project is built by [gradle](https://gradle.org/)

Also tech stack includes [Spring framework](https://projects.spring.io/spring-framework/) in binding with AspectJ. This is used by [event firing feature](https://github.com/appium/java-client/blob/master/docs/The-event_firing.md). Also **CGlib** is used by [Page Object tools](https://github.com/appium/java-client/blob/master/docs/Page-objects.md).
Also tech stack includes [Spring framework](https://spring.io/projects/spring-framework) in binding with AspectJ. This is used by [event firing feature](https://github.com/appium/java-client/blob/master/docs/The-event_firing.md). Also **CGlib** is used by [Page Object tools](https://github.com/appium/java-client/blob/master/docs/Page-objects.md).

It is the client framework. It is the thin client which just sends requests to Appium server and receives responses. Also it has some
high-level features which were designed to simplify user's work.
Expand Down
4 changes: 2 additions & 2 deletions docs/The-event_firing.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ user's implementation of `org.openqa.selenium.support.events.WebDriverEventListe
# Briefly about the engine.

This is pretty similar solution as the `org.openqa.selenium.support.events.EventFiringWebDriver` of the Selenium project. You
can read about this thing there [The blog post](http://seleniumworks.blogspot.ru/2014/02/eventfiringwebdriver.html).
can read about this thing there [The blog post](https://seleniumworks.blogspot.com/2014/02/eventfiringwebdriver.html).

Here we were trying to improve existing drawbacks and restrictions using:

- API splitting, see above.

- the binding of some [Spring framework engines](https://projects.spring.io/spring-framework/) with [AspectJ](https://en.wikipedia.org/wiki/AspectJ).
- the binding of some [Spring framework engines](https://spring.io/projects/spring-framework) with [AspectJ](https://en.wikipedia.org/wiki/AspectJ).

# How to use

Expand Down
14 changes: 7 additions & 7 deletions docs/The-starting-of-an-Android-app.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# Steps:

- you have to prepare environment for Android. [Details are provided here](https://github.com/appium/appium/blob/master/docs/en/drivers/android-uiautomator2.md)
- you have to prepare environment for Android. [Details are provided here](https://appium.io/docs/en/drivers/android-uiautomator2/#basic-setup)

- it needs to launch the appium server. You can launch Appium desktop application. If you use the server installed via npm then

_$ node **the_path_to_main.js_file** --arg1 value1 --arg2 value2_
It is not necessary to use arguments. [The list of arguments](https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/server-args.md)
It is not necessary to use arguments. [The list of arguments](https://appium.io/docs/en/writing-running-appium/server-args/)


# The starting of an app

It looks like creation of a common [RemoteWebDriver](https://selenium.googlecode.com/git/docs/api/java/org/openqa/selenium/remote/RemoteWebDriver.html) instance.
It looks like creation of a common [RemoteWebDriver](https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/remote/RemoteWebDriver.html) instance.

[Common capabilities](https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/caps.md#general-capabilities)
[Common capabilities](https://appium.io/docs/en/writing-running-appium/caps/#general-capabilities)

[Android-specific capabilities](https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/caps.md#android-only)
[Android-specific capabilities](https://appium.io/docs/en/writing-running-appium/caps/#android-only)

[Common capabilities provided by Java client](http://appium.github.io/java-client/io/appium/java_client/remote/MobileCapabilityType.html)
[Common capabilities provided by Java client](https://javadoc.io/page/io.appium/java-client/latest/io/appium/java_client/remote/MobileCapabilityType.html)

[Android-specific capabilities provided by Java client](http://appium.github.io/java-client/io/appium/java_client/remote/AndroidMobileCapabilityType.html)
[Android-specific capabilities provided by Java client](https://javadoc.io/page/io.appium/java-client/latest/io/appium/java_client/remote/AndroidMobileCapabilityType.html)

```java
import java.io.File;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

# The basic principle.

It works the similar way as common [ChromeDriver](https://selenium.googlecode.com/git/docs/api/java/org/openqa/selenium/chrome/ChromeDriver.html), [InternetExplorerDriver](https://selenium.googlecode.com/git/docs/api/java/org/openqa/selenium/ie/InternetExplorerDriver.html) of Selenium project or [PhantomJSDriver](http://cdn.ivandemarino.me/phantomjsdriver-javadoc/org/openqa/selenium/phantomjs/PhantomJSDriver.html). They use subclasses of the [DriverService](https://selenium.googlecode.com/git/docs/api/java/org/openqa/selenium/remote/service/DriverService.html).
It works the similar way as common [ChromeDriver](https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/chrome/ChromeDriver.html), [InternetExplorerDriver](https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/ie/InternetExplorerDriver.html) of Selenium project or [PhantomJSDriver](https://cdn.rawgit.com/detro/ghostdriver/master/binding/java/docs/javadoc/org/openqa/selenium/phantomjs/PhantomJSDriver.html). They use subclasses of the [DriverService](https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/remote/service/DriverService.html).

# Which capabilities this feature provides

Expand Down
14 changes: 7 additions & 7 deletions docs/The-starting-of-an-iOS-app.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# Steps:

- you have to prepare environment for iOS. [Details are provided here](http://appium.io/docs/en/drivers/ios-xcuitest/#basic-setup)
- you have to prepare environment for iOS. [Details are provided here](https://appium.io/docs/en/drivers/ios-xcuitest/#basic-setup)

- it needs to launch the appium server. You can launch Appium desktop application. If you use the server installed via npm then

_$ node **the_path_to_js_file** --arg1 value1 --arg2 value2_
It is not necessary to use arguments. [The list of arguments](http://appium.io/slate/en/master/?java#appium-server-arguments)
It is not necessary to use arguments. [The list of arguments](https://appium.io/docs/en/writing-running-appium/server-args/)

# The starting of an app

It looks like creation of a common [RemoteWebDriver](https://selenium.googlecode.com/git/docs/api/java/org/openqa/selenium/remote/RemoteWebDriver.html) instance.
It looks like creation of a common [RemoteWebDriver](https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/remote/RemoteWebDriver.html) instance.

[Common capabilities](http://appium.io/slate/en/master/?ruby#the---default-capabilities-flag)
[Common capabilities](https://appium.io/docs/en/writing-running-appium/caps/#general-capabilities)

[iOS-specific capabilities](http://appium.io/slate/en/master/?ruby#ios-only)
[iOS-specific capabilities](https://appium.io/docs/en/writing-running-appium/caps/#ios-only)

[Common capabilities provided by Java client](http://appium.github.io/java-client/io/appium/java_client/remote/MobileCapabilityType.html)
[Common capabilities provided by Java client](https://javadoc.io/page/io.appium/java-client/latest/io/appium/java_client/remote/MobileCapabilityType.html)

[iOS-specific capabilities provided by Java client](http://appium.github.io/java-client/io/appium/java_client/remote/IOSMobileCapabilityType.html)
[iOS-specific capabilities provided by Java client](https://javadoc.io/page/io.appium/java-client/latest/io/appium/java_client/remote/IOSMobileCapabilityType.html)


```java
Expand Down
2 changes: 1 addition & 1 deletion docs/environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ In order to understand this topic you should know concept of environment variabl

## How To Verify What Is Missing

Appium itself is a NodeJS application and uses the same environment as its host `node` process. If you experience an error related to local environment setup then verify the actual process environment first. In Mac OS, for example, it is possible to do this via `ps eww <PID>` command, where `PID` is the process identifier of the running Appium's host Node process. In Windows the [ProcessExplorer](technet.microsoft.com/en-us/sysinternals/bb896653.aspx) utility can be used for such purpose. Then make sure the corresponding variable is there and it is set to a proper value, or, in case there is an error finding some binary, make sure the parent folder of this binary is present in `PATH` list, the binary itself on the local file system and can be executed manually.
Appium itself is a NodeJS application and uses the same environment as its host `node` process. If you experience an error related to local environment setup then verify the actual process environment first. In Mac OS, for example, it is possible to do this via `ps eww <PID>` command, where `PID` is the process identifier of the running Appium's host Node process. In Windows the [ProcessExplorer](https://docs.microsoft.com/sysinternals/downloads/process-explorer) utility can be used for such purpose. Then make sure the corresponding variable is there and it is set to a proper value, or, in case there is an error finding some binary, make sure the parent folder of this binary is present in `PATH` list, the binary itself on the local file system and can be executed manually.

## How To Fix Missing Environment Variables

Expand Down