From 41916d0127076175c88653ef2a5d7ca345ad248f Mon Sep 17 00:00:00 2001 From: Takeshi Kishi Date: Mon, 6 May 2019 23:48:51 +0900 Subject: [PATCH] fix links in the documents (#934) * fix moved or deleted contents * replace `http` to `https` --- ISSUE_TEMPLATE.md | 2 +- README.md | 4 ++-- docs/How-to-report-an-issue.md | 2 +- docs/Installing-the-project.md | 2 +- docs/Note-for-developers.md | 2 +- docs/Page-objects.md | 2 +- docs/Tech-stack.md | 2 +- docs/The-event_firing.md | 4 ++-- docs/The-starting-of-an-Android-app.md | 14 +++++++------- ...-Appium-node-server-started-programmatically.md | 2 +- docs/The-starting-of-an-iOS-app.md | 14 +++++++------- docs/environment.md | 2 +- 12 files changed, 26 insertions(+), 26 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index de0ad9449..c38753dee 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -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/) diff --git a/README.md b/README.md index bbb7477b9..df8b7bb8c 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/How-to-report-an-issue.md b/docs/How-to-report-an-issue.md index 0adf13fbf..95be8f584 100644 --- a/docs/How-to-report-an-issue.md +++ b/docs/How-to-report-an-issue.md @@ -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/) diff --git a/docs/Installing-the-project.md b/docs/Installing-the-project.md index 73914e9d5..a354af7f1 100644 --- a/docs/Installing-the-project.md +++ b/docs/Installing-the-project.md @@ -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. diff --git a/docs/Note-for-developers.md b/docs/Note-for-developers.md index 97f9dbe2f..586df8f5e 100644 --- a/docs/Note-for-developers.md +++ b/docs/Note-for-developers.md @@ -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 diff --git a/docs/Page-objects.md b/docs/Page-objects.md index f6b3784b1..7bc36a267 100644 --- a/docs/Page-objects.md +++ b/docs/Page-objects.md @@ -317,7 +317,7 @@ List 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. diff --git a/docs/Tech-stack.md b/docs/Tech-stack.md index e3b66655e..cbaa01b2e 100644 --- a/docs/Tech-stack.md +++ b/docs/Tech-stack.md @@ -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. diff --git a/docs/The-event_firing.md b/docs/The-event_firing.md index e703e5cd7..1dcbc1024 100644 --- a/docs/The-event_firing.md +++ b/docs/The-event_firing.md @@ -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 diff --git a/docs/The-starting-of-an-Android-app.md b/docs/The-starting-of-an-Android-app.md index 21ed62af6..466756677 100644 --- a/docs/The-starting-of-an-Android-app.md +++ b/docs/The-starting-of-an-Android-app.md @@ -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; diff --git a/docs/The-starting-of-an-app-using-Appium-node-server-started-programmatically.md b/docs/The-starting-of-an-app-using-Appium-node-server-started-programmatically.md index 83e93d9d7..6ce685b08 100644 --- a/docs/The-starting-of-an-app-using-Appium-node-server-started-programmatically.md +++ b/docs/The-starting-of-an-app-using-Appium-node-server-started-programmatically.md @@ -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 diff --git a/docs/The-starting-of-an-iOS-app.md b/docs/The-starting-of-an-iOS-app.md index 6eaac0cfd..19b5ba2a0 100644 --- a/docs/The-starting-of-an-iOS-app.md +++ b/docs/The-starting-of-an-iOS-app.md @@ -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 diff --git a/docs/environment.md b/docs/environment.md index 17abe543c..fce3c0c53 100644 --- a/docs/environment.md +++ b/docs/environment.md @@ -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 ` 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 ` 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