Skip to content

Commit a8d7e98

Browse files
Gunnar Johanssondiemol
Gunnar Johansson
authored andcommitted
Update small things on website (#380)
* Update the_selenium_project_and_tools.en.md Small spelling fix * Update on_test_automation.en.md Small format change * Update types_of_testing.en.md Small spelling and formatting changes * Update installing_webdriver_binaries.en.md Minor grammar * Update installing_standalone_server.en.md Minor language * Update browsers.en.md Harmonize spelling * Update locating_elements.en.md Minor grammar * Update _index.en.md Minor language * Update understanding_the_components.en.md Consistency with other locations * Update driver_requirements.en.md Clearer language * Update driver_requirements.en.md Minor changes * Update browser_manipulation.en.md Minor changes for clarity * Update waits.en.md Minor change * Update js_alerts_prompts_and_confirmations.en.md Change message to plural * Update web_element.en.md Make complete sentence * Update keyboard.en.md Make complete sentence * Update remote_webdriver_server.en.md Clarify language * Update remote_webdriver_client.en.md Update first sentence * Update _index.en.md Move a period for small grammar change * Update page_object_models.en.md Add footnote to explain acronym * Update domain_specific_language.en.md * Update page_object_models.en.md Add extra letter missing in the last commit for this page * Update generating_application_state.en.md Add footnote and change word to plural * Update improved_reporting.en.md Add some links * Update avoid_sharing_state.en.md Add bullets to list * Update test_independency.en.md Change colon to period * Harmonize syntax and fixing some minor things * Update docs_source_files/content/getting_started_with_webdriver/locating_elements.en.md Co-Authored-By: Diego Molina <diemol@users.noreply.github.com> * Update docs_source_files/content/support_packages/mouse_and_keyboard_actions_in_detail.en.md Co-Authored-By: Diego Molina <diemol@users.noreply.github.com> * Update docs_source_files/content/webdriver/browser_manipulation.en.md Co-Authored-By: Diego Molina <diemol@users.noreply.github.com> * Update links in all languages
1 parent a61d34c commit a8d7e98

File tree

55 files changed

+212
-190
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+212
-190
lines changed

docs_source_files/content/getting_started/html-runner.en.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ campatible tools.
1313
* Combination of releases of geckodriver / firefox /
1414
selenium-html-runner matters. There might be a software
1515
compatibility matrix somewhere.
16-
* selenium-html-runner runs only Test Suite (not Test Case - what
17-
is for example an export from Monitis Transaction Monitor). Be
16+
* selenium-html-runner runs only Test Suite (not Test Case -
17+
for example an export from Monitis Transaction Monitor). Be
1818
sure you comply with this.
1919
* For Linux users with no DISPLAY - you need to start html-runner
2020
with Virtual display (search for xvfb)

docs_source_files/content/getting_started/quick.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Selenium IDE can be used to generate _quick and dirty_
4343
Java, Python, and Ruby). Given the maintainability of code generated
4444
through Selenium IDE, it is not recommended to use it for anything
4545
more than getting acquainted with element locators or generating
46-
_throw away code_. We're sure that once you get used to the
46+
_throw away code_. We are sure that once you get used to the
4747
WebDriver API, you will never use Selenium IDE.
4848

4949

docs_source_files/content/getting_started_with_webdriver/browsers.en.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The Selenium framework officially supports the following browsers:
1515
| Opera | Opera [Chromium](//github.com/operasoftware/operachromiumdriver/) / [Presto](//github.com/operasoftware/operaprestodriver) | 10.5 and newer |
1616
| Safari | [Apple](//webkit.org/blog/6900/webdriver-support-in-safari-10/) | 10 and newer |
1717

18-
## Specialised browsers
18+
## Specialized browsers
1919

2020
There is also a set of specialized browsers out there
2121
typically used in development environments.
@@ -24,4 +24,4 @@ and Selenium ties in support for the following specialized drivers:
2424

2525
| Driver Name | Purpose | Maintainer |
2626
| -------- | ---------- | ------------------ |
27-
| HtmlUnitDriver | Headless browser emulator backed by Rhino | Selenium project |
27+
| HtmlUnitDriver | Headless browser emulator backed by Rhino | Selenium project |

docs_source_files/content/getting_started_with_webdriver/locating_elements.en.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ const cheddar = await driver.findElement(By.css('#cheese #cheddar'));
105105

106106
### Locating multiple elements
107107

108-
It's possible that the document we are working with may turn out to have an
108+
It is possible that the document we are working with may turn out to have an
109109
ordered list of the cheese we like the best:
110110

111111
```html
@@ -122,7 +122,7 @@ to have to retrieve each of the items individually, a superior
122122
technique for retrieving cheese is to make use of the pluralized
123123
version `findElements(By)`. This method returns a collection of web
124124
elements. If only one element is found, it will still return a
125-
collection (of one element). If no elements match the locator, an
125+
collection (of one element). If no element matches the locator, an
126126
empty list will be returned.
127127

128128
{{< code-tab >}}
@@ -168,7 +168,7 @@ that comes with complicated DOM traversals.
168168
If unique IDs are unavailable, a well-written CSS selector is the
169169
preferred method of locating an element. XPath works as well as CSS
170170
selectors, but the syntax is complicated and frequently difficult to
171-
debug. Though XPath selectors are very flexible, they're typically
171+
debug. Though XPath selectors are very flexible, they are typically
172172
not performance tested by browser vendors and tend to be quite slow.
173173

174174
Selection strategies based on link text and partial link text have

docs_source_files/content/grid/_index.en.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ one server acts as the hub that routes JSON formatted test commands
1515
to one or more registered Grid nodes.
1616
Tests contact the hub to obtain access to remote browser instances.
1717
The hub has a list of registered servers that it provides access to,
18-
and allows us to control these instances.
18+
and allows control of these instances.
1919

2020
Selenium Grid allows us to run tests in parallel on multiple machines,
2121
and to manage different browser versions and browser configurations centrally
2222
(instead of in each individual test).
2323

24-
Selenium Grid isn't a silver bullet.
24+
Selenium Grid is not a silver bullet.
2525
It solves a subset of common delegation and distribution problems,
26-
but will for example not manage your infrastructure
26+
but will for example not manage your infrastructure,
2727
and might not suit your specific needs.

docs_source_files/content/grid/components_of_a_grid.en.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,22 @@ weight: 2
1111
* Takes instructions from client and executes them remotely on the nodes
1212
* Manages threads
1313

14-
A _Hub_ is a central point where all your tests are sent to.
14+
A _Hub_ is a central point where all your tests are sent.
1515
Each Selenium Grid consists of exactly one hub. The hub needs to be reachable
1616
from the respective clients (i.e. CI server, Developer machine etc.)
1717
The hub will connect one or more nodes
1818
that tests will be delegated to.
1919

2020
## Nodes
2121

22-
* This is where the browsers live
22+
* Where the browsers live
2323
* Registers itself to the hub and communicates its capabilities
2424
* Receives requests from the hub and executes them
2525

2626
_Nodes_ are different Selenium instances
2727
that will execute tests on individual computer systems.
2828
There can be many nodes in a grid.
29-
The machines which are nodes need do not need to be the same platform
29+
The machines which are nodes do not need to be the same platform
3030
or have the same browser selection as that of the hub or the other nodes.
3131
A node on Windows might have the capability of
3232
offering Internet Explorer as a browser option,

docs_source_files/content/grid/purposes_and_main_functionalities.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ weight: 1
55
---
66

77
* Central entry point for all tests
8-
* Management and control of the nodes / environment where the browsers run on
8+
* Management and control of the nodes / environment where the browsers run
99
* Scaling
1010
* Running tests in parallel
1111
* Cross platform testing

docs_source_files/content/grid/setting_up_your_own_grid.en.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ complete with its own node infrastructure.
2121

2222
This example will show you how to start the Selenium 2 Grid Hub,
2323
and register both a WebDriver node and a Selenium 1 RC legacy node.
24-
We’ll also show you how to call the grid from Java.
24+
We will also show you how to call the grid from Java.
2525
The hub and nodes are shown here running on the same machine,
2626
but of course you can copy the selenium-server-standalone to multiple machines.
2727

@@ -66,7 +66,7 @@ are possible command-line flags.
6666

6767
You certainly can get by with only the simple command shown above,
6868
but if you need more advanced configuration,
69-
then you may also for convenience specify a JSON format config file
69+
you can also specify a JSON format config file, for convenience,
7070
to configure the hub when you start it.
7171
You can do it like so:
7272

@@ -192,26 +192,26 @@ hub/node to be reachable from a different machine.
192192
#### Specifying the port
193193

194194
The default TCP/IP port used by the hub is 4444. If you need to change the port
195-
please use above mentioned configurations
195+
please use above mentioned configurations.
196196

197197
## Troubleshooting
198198

199199
### Using Log file
200-
For advance troubleshooting you can specify log file to log system messages.
201-
For that start Selenium GRID hub or node with -log argument. Please see the below example
200+
For advanced troubleshooting you can specify a log file to log system messages.
201+
Start Selenium GRID hub or node with -log argument. Please see the below example:
202202

203203
```shell
204204
java -jar selenium-server-standalone.jar -role hub -log log.txt
205205
```
206206

207-
Use your favorite text editor to open log file (log.txt in above example) to find
207+
Use your favorite text editor to open log file (log.txt in the example above) to find
208208
"ERROR" logs if you get issues.
209209

210210
### Using `-debug` argument
211211

212-
Also you can use `-debug` argument to print debug logs on console.
213-
For that start Selenium Grid Hub or Node with `-debug` argument. Please see
214-
the below example
212+
Also you can use `-debug` argument to print debug logs to console.
213+
Start Selenium Grid Hub or Node with `-debug` argument. Please see
214+
the below example:
215215

216216
```shell
217217
java -jar selenium-server-standalone.jar -role hub -debug
@@ -223,11 +223,12 @@ The Selenium Grid must be protected from external access using appropriate
223223
firewall permissions.
224224

225225
Failure to protect your Grid could result in one or more of the following occurring:
226+
226227
* You provide open access to your Grid infrastructure
227-
* You allow 3rd parties to access internal web applications and files
228-
* You allow 3rd parties to run custom binaries
228+
* You allow third parties to access internal web applications and files
229+
* You allow third parties to run custom binaries
229230

230-
See this blog post on [Detectify](//labs.detectify.com) which gives a good
231+
See this blog post on [Detectify](//labs.detectify.com), which gives a good
231232
overview of how a publicly exposed Grid could be misused:
232233
[Don't Leave your Grid Wide Open](//labs.detectify.com/2017/10/06/guest-blog-dont-leave-your-grid-wide-open/).
233234

@@ -236,7 +237,7 @@ overview of how a publicly exposed Grid could be misused:
236237
[Docker](//www.docker.com/) provides a convenient way to
237238
provision and scale Selenium Grid infrastructure in a unit known as a container.
238239
Containers are standardised units of software that contain everything required
239-
to run the desired application including all dependencies in a reliable and repeatable
240+
to run the desired application, including all dependencies, in a reliable and repeatable
240241
way on different machines.
241242

242243
The Selenium project maintains a set of Docker images which you can download

docs_source_files/content/guidelines_and_recommendations/_index.en.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,20 @@ weight: 7
99

1010
A note on "Best Practices": We've intentionally avoided the phrase "Best
1111
Practices" in this documentation. No one approach works for all situations.
12-
We prefer the idea of "Guidelines and Recommendations." We encourage
12+
We prefer the idea of "Guidelines and Recommendations". We encourage
1313
you to read through these and thoughtfully decide what approaches
1414
will work for you in your particular environment.
1515

1616
Functional testing is difficult to get right for many reasons.
17-
As if application state, complexity, and dependencies don't make testing difficult enough,
17+
As if application state, complexity, and dependencies do not make testing difficult enough,
1818
dealing with browsers (especially with cross-browser incompatibilities)
1919
makes writing good tests a challenge.
2020

2121
Selenium provides tools to make functional user interaction easier,
22-
but doesn't help you write well-architected test suites.
22+
but does not help you write well-architected test suites.
2323
In this chapter we offer advice, guidelines, and recommendations.
2424
on how to approach functional web page automation.
2525

2626
This chapter records software design patterns popular
2727
amongst many of the users of Selenium
28-
that have proven successful over the years.
28+
that have proven successful over the years.

docs_source_files/content/guidelines_and_recommendations/avoid_sharing_state.en.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ weight: 6
66
Although mentioned in several places it is worth mentioning again. Ensure
77
tests are isolated from one another.
88

9-
Don't share test data. Imagine several tests that each query the database
9+
* Do not share test data. Imagine several tests that each query the database
1010
for valid orders before picking one to perform an action on. Should two tests
1111
pick up the same order you are likely to get unexpected behaviour.
1212

13-
Clean up stale data in the application that might be picked up by another
13+
* Clean up stale data in the application that might be picked up by another
1414
test e.g. invalid order records.
1515

16-
Create a new WebDriver instance per test. This helps ensure test isolation
16+
* Create a new WebDriver instance per test. This helps ensure test isolation
1717
and makes parallelisation simpler.

docs_source_files/content/guidelines_and_recommendations/consider_using_a_fluent_api.en.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: "Consider using a fluent API"
33
weight: 8
44
---
55

6-
Martin Fowler coined the term "Fluent API". Selenium already
7-
implements something like this in their `FluentWait` class which is
6+
Martin Fowler coined the term ["Fluent API"](//www.martinfowler.com/bliki/FluentInterface.html). Selenium already
7+
implements something like this in their `FluentWait` class, which is
88
meant as an alternative to the standard <code>Wait</code> class.
99
You could enable the Fluent API design pattern in your page object
1010
and then query the Google search page with a code snippet like this one:

docs_source_files/content/guidelines_and_recommendations/consider_using_a_fluent_api.es.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ English to Spanish. Do you speak Spanish? Help us to translate
99
it by sending us pull requests!
1010
{{% /notice %}}
1111

12-
Martin Fowler coined the term "Fluent API". Selenium already
13-
implements something like this in their `FluentWait` class which is
12+
Martin Fowler coined the term ["Fluent API"](//www.martinfowler.com/bliki/FluentInterface.html).
13+
Selenium already implements something like this in their `FluentWait` class which is
1414
meant as an alternative to the standard <code>Wait</code> class.
1515
You could enable the Fluent API design pattern in your page object
1616
and then query the Google search page with a code snippet like this one:

docs_source_files/content/guidelines_and_recommendations/consider_using_a_fluent_api.fr.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ English to French. Do you speak French? Help us to translate
99
it by sending us pull requests!
1010
{{% /notice %}}
1111

12-
Martin Fowler coined the term "Fluent API". Selenium already
13-
implements something like this in their `FluentWait` class which is
12+
Martin Fowler coined the term ["Fluent API"](//www.martinfowler.com/bliki/FluentInterface.html).
13+
Selenium already implements something like this in their `FluentWait` class which is
1414
meant as an alternative to the standard <code>Wait</code> class.
1515
You could enable the Fluent API design pattern in your page object
1616
and then query the Google search page with a code snippet like this one:

docs_source_files/content/guidelines_and_recommendations/consider_using_a_fluent_api.ja.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ weight: 8
88
日本語は話せますか?プルリクエストをして翻訳を手伝ってください!
99
{{% /notice %}}
1010

11-
Martin Fowler coined the term "Fluent API". Selenium already
12-
implements something like this in their `FluentWait` class which is
11+
Martin Fowler coined the term ["Fluent API"](//www.martinfowler.com/bliki/FluentInterface.html).
12+
Selenium already implements something like this in their `FluentWait` class which is
1313
meant as an alternative to the standard <code>Wait</code> class.
1414
You could enable the Fluent API design pattern in your page object
1515
and then query the Google search page with a code snippet like this one:

docs_source_files/content/guidelines_and_recommendations/consider_using_a_fluent_api.nl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ English to Dutch. Do you speak Dutch? Help us to translate
99
it by sending us pull requests!
1010
{{% /notice %}}
1111

12-
Martin Fowler coined the term "Fluent API". Selenium already
13-
implements something like this in their `FluentWait` class which is
12+
Martin Fowler coined the term ["Fluent API"](//www.martinfowler.com/bliki/FluentInterface.html).
13+
Selenium already implements something like this in their `FluentWait` class which is
1414
meant as an alternative to the standard <code>Wait</code> class.
1515
You could enable the Fluent API design pattern in your page object
1616
and then query the Google search page with a code snippet like this one:

docs_source_files/content/guidelines_and_recommendations/consider_using_a_fluent_api.zh-cn.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ weight: 8
88
您熟悉英语与简体中文吗?帮助我们翻译它,通过 pull requests 给我们!
99
{{% /notice %}}
1010

11-
Martin Fowler coined the term "Fluent API". Selenium already
12-
implements something like this in their `FluentWait` class which is
11+
Martin Fowler coined the term ["Fluent API"](//www.martinfowler.com/bliki/FluentInterface.html).
12+
Selenium already implements something like this in their `FluentWait` class which is
1313
meant as an alternative to the standard <code>Wait</code> class.
1414
You could enable the Fluent API design pattern in your page object
1515
and then query the Google search page with a code snippet like this one:

docs_source_files/content/guidelines_and_recommendations/domain_specific_language.en.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ A domain specific language (DSL) is a system which provides the user with
77
an expressive means of solving a problem. It allows a user to
88
interact with the system on their terms – not just programmer-speak.
99

10-
Your users, in general, don't care how your site looks. They don't
10+
Your users, in general, do not care how your site looks. They do not
1111
care about the decoration, animations, or graphics. They
1212
want to use your system to push their new employees through the
13-
process with minimal difficulty. They want to book travel to Alaska.
14-
They want to configure and buy unicorns at a discount. Your job as the
13+
process with minimal difficulty; they want to book travel to Alaska;
14+
they want to configure and buy unicorns at a discount. Your job as
1515
tester is to come as close as you can to “capturing” this mind-set.
16-
With that in mind, we set about “modeling” the application you're
16+
With that in mind, we set about “modeling” the application you are
1717
working on, such that the test scripts (the user's only pre-release
18-
proxy) “speak” for and represent the user.
18+
proxy) “speak” for, and represent the user.
1919

2020
With Selenium, DSL is usually represented by methods, written to make
2121
the API simple and readable – they enable a report between the
@@ -29,7 +29,7 @@ intelligence specialists, etc.).
2929
* **Extensible:** Functionality can (reasonably) be added
3030
without breaking contracts and existing functionality.
3131
* **Maintainable:** By leaving the implementation details out of test
32-
cases, you are well-insulated against changes to the AUT (application under test).
32+
cases, you are well-insulated against changes to the AUT*.
3333

3434

3535
## Java
@@ -65,7 +65,7 @@ public AccountPage loginAsUser(String username, String password) {
6565

6666
This method completely abstracts the concepts of input fields,
6767
buttons, clicking, and even pages from your test code. Using this
68-
approach, all your tester has to do is call this method. This gives
68+
approach, all a tester has to do is call this method. This gives
6969
you a maintenance advantage: if the login fields ever changed, you
7070
would only ever have to change this method - not your tests.
7171

@@ -87,9 +87,11 @@ public void loginTest() {
8787
It bears repeating: one of your primary goals should be writing an
8888
API that allows your tests to address **the problem at hand, and NOT
8989
the problem of the UI**. The UI is a secondary concern for your
90-
users – they don't care about the UI, they just want to get their job
90+
users – they do not care about the UI, they just want to get their job
9191
done. Your test scripts should read like a laundry list of things
9292
the user wants to DO, and the things they want to KNOW. The tests
9393
should not concern themselves with HOW the UI requires you to go
9494
about it.
9595

96+
***AUT**: Application under test
97+

docs_source_files/content/guidelines_and_recommendations/generating_application_state.en.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,13 @@ weight: 3
44
---
55

66
Selenium should not be used to prepare a test case. All repetitive
7-
actions, and preparation for a test case, should be done through other
7+
actions and preparations for a test case, should be done through other
88
methods. For example, most web UIs have authentication (e.g. a login
99
form). Eliminating logging in via web browser before every test will
1010
improve both the speed and stability of the test. A method should be
11-
created to gain access to the AUT (e.g. using an API to login and set a
11+
created to gain access to the AUT* (e.g. using an API to login and set a
1212
cookie). Also, creating methods to pre-load data for
1313
testing should not be done using Selenium. As mentioned previously,
14-
existing APIs should be leveraged to create data for the AUT.
14+
existing APIs should be leveraged to create data for the AUT*.
15+
16+
***AUT**: Application under test

docs_source_files/content/guidelines_and_recommendations/improved_reporting.en.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,9 @@ reports that can generate xUnit or HTML formatted reports. xUnit
1010
reports are popular for importing results to a Continuous Integration
1111
(CI) server like Jenkins, Travis, Bamboo, etc. Here are some links
1212
for more information regarding report outputs for several languages.
13-
<!-- TODO: Add links.-->
13+
<!-- TODO: Add links.-->
14+
[NUnit 3 Console Runner](//github.com/nunit/docs/wiki/Console-Runner)
15+
[NUnit 3 Console Command Line](//github.com/nunit/docs/wiki/Console-Command-Line)
16+
[xUnit getting test results in TeamCity](//xunit.net/docs/getting-test-results-in-teamcity)
17+
[xUnit getting test results in CruiseControl.NET](//xunit.net/docs/getting-test-results-in-ccnet)
18+
[xUnit getting test results in Azure DevOps](//xunit.net/docs/getting-test-results-in-azure-devops)

docs_source_files/content/guidelines_and_recommendations/improved_reporting.es.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,5 @@ reports that can generate xUnit or HTML formatted reports. xUnit
1616
reports are popular for importing results to a Continuous Integration
1717
(CI) server like Jenkins, Travis, Bamboo, etc. Here are some links
1818
for more information regarding report outputs for several languages.
19-
<!-- TODO: Add links.-->
19+
<!-- TODO: Add links.-->
20+
[NUnit 3 Console Runner](//github.com/nunit/docs/wiki/Console-Runner)

0 commit comments

Comments
 (0)