Skip to content

Commit 93f615b

Browse files
diemoldiemol
committed
Building up an initial docs flow [skip ci]
1 parent 18f2d6d commit 93f615b

File tree

10 files changed

+486
-26
lines changed

10 files changed

+486
-26
lines changed

‎website_hugo_files/content/documentation/_index.de.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ cascade:
55
- type: docs
66
---
77

8+
{{% pageinfo color="warning" %}}
9+
<p class="lead">
10+
<i class="fas fa-language display-4"></i>
11+
Diese Seite wird von Englisch
12+
auf Deutsch übersetzt. Sprichst Du Deutsch? Hilf uns die Seite
13+
zu übersetzen indem Du uns einen Pull Reqeust schickst!
14+
</p>
15+
{{% /pageinfo %}}
816

917
Selenium ist ein Sammlung von Projekten für einige Werkzeuge und Programmbibliotheken
1018
die es ermöglichen Webbrowser zu automatisieren.
@@ -24,7 +32,7 @@ Selenium fördert Disskussionen in Bezug Automation der Webplattform mit Browser
2432
Ingeneure und Enthusiasten. Jedes Jahr wird vom Projekt eine [Konferenz](//seleniumconf.com/)
2533
organisiert um Wissen zu vermitteln und die Community zu fördern.
2634

27-
Das Herzstück von Selenium ist der _[WebDriver]({{< ref "/webdriver.md" >}})_. Es
35+
Das Herzstück von Selenium ist der [WebDriver]({{< ref "/webdriver.md" >}}). Es
2836
handelt sich um ein Interface um das es ermöglicht Befehle für eine Vielzahl von Browsern
2937
auszuführen. Hier ein einfaches Beispiel welche Möglichkeiten geboten werden:
3038

@@ -151,10 +159,11 @@ fun main() {
151159

152160

153161

154-
Sie Dir die _[Kurzeinführung]({{< ref "/overview.md" >}})_ an um detailierte
155-
Informationen zu erhalten was im Hintergrund passiert wenn Du diesen Code ausführst.
156-
Du solltest mit der [Einführung]({{</* ref "/introduction/_index.md" */>}}) fortsetzen
157-
um die [Installation]({{</* ref "/selenium_installation/_index.md" */>}})
158-
zu verstehen und um Selenium erfolgreich einzusetzen, Testsets in größeren
159-
Umfang einzusetzen auf vielen verschiedenen Browsern und unterschiedlichen Betriebssystemen.
162+
See the [Overview]({{< ref "/overview.md" >}}) to check the different project
163+
components and decide if Selenium is the right tool for you.
164+
165+
You should continue on to [Getting Started]({{</* ref "/getting_started.md" */>}})
166+
to understand how you can install Selenium and successfully use it as a test
167+
automation tool, and scaling simple tests like this to run in large, distributed
168+
environments on multiple browsers, on several different operating systems.
160169

‎website_hugo_files/content/documentation/_index.en.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ to further an open discussion around automation of the web platform.
2525
The project organises [an annual conference](//seleniumconf.com/)
2626
to teach and nurture the community.
2727

28-
At the core of Selenium is _[WebDriver](/documentation/webdriver)_,
28+
At the core of Selenium is [WebDriver](/documentation/webdriver),
2929
an interface to write instruction sets that can be run interchangeably in many
3030
browsers. Here is one of the simplest instructions you can make:
3131

@@ -149,14 +149,13 @@ fun main() {
149149
{{< /tab >}}
150150
{{< /tabpane >}}
151151

152-
See the _[Overview]({{< ref "/overview.md" >}})_ for a full explanation
153-
of what goes on behind the scenes when you run this code.
154-
You should continue on to the [narrative documentation]({{</* ref "/introduction/_index.md" */>}})
155-
to understand how you can [install]({{</* ref "/selenium_installation/_index.md" */>}}) and
156-
successfully use Selenium as a test automation tool,
157-
and scaling simple tests like this to run
158-
in large, distributed environments on multiple browsers,
159-
on several different operating systems.
152+
See the [Overview]({{< ref "/overview.md" >}}) to check the different project
153+
components and decide if Selenium is the right tool for you.
154+
155+
You should continue on to [Getting Started]({{< ref "/getting_started.md" >}})
156+
to understand how you can install Selenium and successfully use it as a test
157+
automation tool, and scaling simple tests like this to run in large, distributed
158+
environments on multiple browsers, on several different operating systems.
160159

161160

162161

‎website_hugo_files/content/documentation/getting_started/_index.de.md

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
---
2+
title: "Erste Schritte"
3+
linkTitle: "Erste Schritte"
4+
weight: 3
5+
description: >
6+
If you are new to Selenium, we have a few resources that can help you get up to speed right away.
7+
---
8+
9+
{{% pageinfo color="warning" %}}
10+
<p class="lead">
11+
<i class="fas fa-language display-4"></i>
12+
Diese Seite wird von Englisch
13+
auf Deutsch übersetzt. Sprichst Du Deutsch? Hilf uns die Seite
14+
zu übersetzen indem Du uns einen Pull Reqeust schickst!
15+
</p>
16+
{{% /pageinfo %}}
17+
18+
19+
Die Installation von Selenium unterscheidet sich grundlegend von
20+
der Installation kommerzieller Tools. Um Selenium in Deinem Automationsprojekt
21+
zu verwenden, ist es notwendig zuerst die entsprechenden Bibliotheken der
22+
verwendeten Programmiersprache zu installieren. Weiters benötigst Du die passenden
23+
WebDriver Dateien entsprechend des verwendeten Browsers, der für die Automation
24+
benötigt, und auf dem die Tests ausgeführt werden.
25+
26+
Intalling Selenium can be divided in three steps:
27+
28+
1. Installing the Selenium library for your desired programming language
29+
2. Set up the browser driver to automate your browser (e.g. GeckoDriver for Firefox)
30+
3. (Optional) Set up and configure [Selenium Grid]({{</* ref "/grid/_index.md" */>}}) if you want to scale up your tests
31+
32+
If you wish to start with a low-code/record and playback tool, please check
33+
[Selenium IDE](https://selenium.dev/selenium-ide)
34+
35+
36+
37+
## Bibliotheken installieren
38+
39+
Zu Beginn ist es notwendig das die Selenium Bindings für Dein
40+
Automationsprojekt installiert werden. Der Installationsprozess ist von der
41+
gewählten Programmiersprache abhängig.
42+
43+
44+
### Java
45+
Die Installation der Selenium Bibliotheken für Java kann mit Hilfe von
46+
Maven erfolgen. Füge in Deinem Projekt in die pom.xml die _selenium-java_
47+
dependecy hinzu.
48+
49+
```xml
50+
<dependency>
51+
<groupId>org.seleniumhq.selenium</groupId>
52+
<artifactId>selenium-java</artifactId>
53+
<version>4.X</version>
54+
</dependency>
55+
```
56+
57+
Mit der _selenium-java_ dependency ist es möglich Tests laufen zu lassen
58+
in allen von Selenium unterstützen Browsern. Falls Du Test nur in einem
59+
spezifischen Browser ausführen möchtest, ist es möglich auch nur die
60+
dependecy für den gewählten Browser in der _pom.xml_ hinzuzufügen.
61+
62+
Wenn Du zum Beispiel Tests nur in Firefox ausführen möchtest, füge folgende
63+
dependecy in die _pom.xml_ hinzu:
64+
65+
```xml
66+
<dependency>
67+
<groupId>org.seleniumhq.selenium</groupId>
68+
<artifactId>selenium-firefox-driver</artifactId>
69+
<version>4.X</version>
70+
</dependency>
71+
```
72+
73+
Analog wenn Du die Tests nur in Chrome ausführen möchtest, musst Du folgende
74+
dependecy hinzufügen:
75+
76+
```xml
77+
<dependency>
78+
<groupId>org.seleniumhq.selenium</groupId>
79+
<artifactId>selenium-chrome-driver</artifactId>
80+
<version>4.X</version>
81+
</dependency>
82+
```
83+
84+
### Python
85+
Die Installation der Selenium Bibliotheken for Phython can mittels _pip_ erfolgen:
86+
87+
```shell
88+
pip install selenium
89+
```
90+
91+
Alternativ kannst Du den [PyPI Quellcode](https://pypi.org/project/selenium/#files)
92+
(selenium-x.x.x.tar.gz) downloaden und diesen mittels _steup.py_ installieren:
93+
94+
95+
```shell
96+
python setup.py install
97+
```
98+
99+
### C#
100+
Die Installation der Selenium Bibliotheken für C# kann mittels _NuGet_ erfolgen:
101+
102+
```shell
103+
# Using package manager
104+
Install-Package Selenium.WebDriver
105+
# or using .Net CLI
106+
dotnet add package Selenium.WebDriver
107+
```
108+
109+
### Ruby
110+
Die Selenium Bibliotheken für Ruby können mittels _gem_ installiert werden:
111+
112+
```shell
113+
gem install selenium-webdriver
114+
```
115+
116+
### JavaScript
117+
Die Installation der Selenium Bibliotheken für JavaScript kann mit npm durchgeführt werden:
118+
119+
```shell
120+
npm install selenium-webdriver
121+
```
122+
123+
### Kotlin
124+
Da es noch keine Implementierung für Kotlin gibt, müssen die Java Bibliothken verwendet werden,
125+
diese können analg zu [Java](#java) mittels maven eingebunden werden.
126+
127+
## Set up the browser driver
128+
129+
Instructions to set up the browser driver differ between browsers, you can check
130+
the following links to read the instructions for your desired browser.
131+
132+
- Firefox ([Mozilla GeckoDriver](https://github.com/mozilla/geckodriver/))
133+
- Edge ([Microsoft EdgeDriver](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/))
134+
- Chrome ([Google ChromeDriver](https://sites.google.com/a/chromium.org/chromedriver/))
135+
- Opera ([Opera ChromiumDriver](https://github.com/operasoftware/operachromiumdriver))
136+
- Safari ([Apple SafariDriver](https://developer.apple.com/documentation/webkit/about_webdriver_for_safari))
137+
- Internet Explorer ([Internet Explorer Driver Server](https://github.com/SeleniumHQ/selenium/wiki/InternetExplorerDriver))
138+
139+
After completing the setup, you can run the code snippet shown at the
140+
[starting page](/de/documentation) in our docs. Then head to the
141+
[WebDriver]({{< ref "/webdriver.md" >}}) section to learn more about
142+
browser automation with Selenium.

‎website_hugo_files/content/documentation/getting_started/_index.en.md

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
---
2+
title: "Getting Started"
3+
linkTitle: "Getting Started"
4+
weight: 3
5+
description: >
6+
If you are new to Selenium, we have a few resources that can help you get up to speed right away.
7+
---
8+
9+
Selenium setup is quite different from the setup of other commercial tools.
10+
To use Selenium in your automation project you need to install the language
11+
bindings libraries for your language of choice. In addition you will need
12+
WebDriver binaries for the browsers you want to automate and run test on.
13+
14+
Intalling Selenium can be divided in three steps:
15+
16+
1. Installing the Selenium library for your desired programming language
17+
2. Set up the browser driver to automate your browser (e.g. GeckoDriver for Firefox)
18+
3. (Optional) Set up and configure [Selenium Grid]({{</* ref "/grid/_index.md" */>}}) if you want to scale up your tests
19+
20+
If you wish to start with a low-code/record and playback tool, please check
21+
[Selenium IDE](https://selenium.dev/selenium-ide)
22+
23+
24+
## Installing Selenium libraries
25+
26+
First you need to install the Selenium bindings for your automation project.
27+
The installation process for libraries depends on the language you choose to use.
28+
29+
### Java
30+
Installation of Selenium libraries for Java can be done using Maven.
31+
Add the _selenium-java_ dependency in your project pom.xml:
32+
33+
```xml
34+
<dependency>
35+
<groupId>org.seleniumhq.selenium</groupId>
36+
<artifactId>selenium-java</artifactId>
37+
<version>4.X</version>
38+
</dependency>
39+
```
40+
41+
The _selenium-java_ dependency supports running your automation
42+
project with all Selenium supported browsers. If you want to run tests
43+
only in a specific browser, you can add the dependency for that browser
44+
in your _pom.xml_ file.
45+
For example, you should add following dependency in your _pom.xml_
46+
file to run your tests only in Firefox:
47+
48+
```xml
49+
<dependency>
50+
<groupId>org.seleniumhq.selenium</groupId>
51+
<artifactId>selenium-firefox-driver</artifactId>
52+
<version>4.X</version>
53+
</dependency>
54+
```
55+
56+
In a similar manner, if you want to run tests only in Chrome,
57+
you should add the following dependency:
58+
59+
```xml
60+
<dependency>
61+
<groupId>org.seleniumhq.selenium</groupId>
62+
<artifactId>selenium-chrome-driver</artifactId>
63+
<version>4.X</version>
64+
</dependency>
65+
```
66+
67+
### Python
68+
Installation of Selenium libraries for Python can be done using pip:
69+
70+
```shell
71+
pip install selenium
72+
```
73+
74+
Alternatively you can download the [PyPI source archive](https://pypi.org/project/selenium/#files)
75+
(selenium-x.x.x.tar.gz) and install it using _setup.py_:
76+
77+
```shell
78+
python setup.py install
79+
```
80+
81+
### C#
82+
Installation of Selenium libraries for C# can be done using NuGet:
83+
84+
```shell
85+
# Using package manager
86+
Install-Package Selenium.WebDriver
87+
# or using .Net CLI
88+
dotnet add package Selenium.WebDriver
89+
```
90+
91+
### Ruby
92+
Installation of Selenium libraries for Ruby can be done using gem:
93+
94+
```shell
95+
gem install selenium-webdriver
96+
```
97+
98+
### JavaScript
99+
Installation of Selenium libraries for JavaScript can be done using npm:
100+
101+
```shell
102+
npm install selenium-webdriver
103+
```
104+
105+
### Kotlin
106+
Due to missing native language bindings for Kotlin, you have to use the
107+
Java Bindings, e.g. with maven [Java](#java)
108+
109+
110+
## Set up the browser driver
111+
112+
Instructions to set up the browser driver differ between browsers, you can check
113+
the following links to read the instructions for your desired browser.
114+
115+
- Firefox ([Mozilla GeckoDriver](https://github.com/mozilla/geckodriver/))
116+
- Edge ([Microsoft EdgeDriver](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/))
117+
- Chrome ([Google ChromeDriver](https://sites.google.com/a/chromium.org/chromedriver/))
118+
- Opera ([Opera ChromiumDriver](https://github.com/operasoftware/operachromiumdriver))
119+
- Safari ([Apple SafariDriver](https://developer.apple.com/documentation/webkit/about_webdriver_for_safari))
120+
- Internet Explorer ([Internet Explorer Driver Server](https://github.com/SeleniumHQ/selenium/wiki/InternetExplorerDriver))
121+
122+
After completing the setup, you can run the code snippet shown at the
123+
[starting page](/documentation) in our docs. Then head to the
124+
[WebDriver](/documentation/webdriver) section to learn more about
125+
browser automation with Selenium.

‎website_hugo_files/content/documentation/overview/_index.de.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ Selenium ist nicht ein einzelnes Tool oder eine API, es besteht aus mehreren Too
2121
## WebDriver
2222

2323
Startest Du mit dem automatisieren von Websiten, dann wirst Du die WebDriver APIs verwenden.
24-
_[WebDriver]({{< ref "/webdriver.md" >}})_ verwendet die von den Browsern
24+
[WebDriver]({{< ref "/webdriver.md" >}}) verwendet die von den Browsern
2525
Herstellern zur Verfügung gestellten APIs um den Browser zu steuern und Test
2626
auszuführen. Die Ausführung simuliert einen echten Benutzer. Da der WebDriver eigenständig
2727
ist und nicht mit der Applikation kompiliert werden muss, handelt es sich um eine minimal
2828
invasive Methode. Es kann exakt die Applikation getestet werden die später veröffentlicht wird.
2929

3030
## IDE
3131

32-
_[IDE](https://selenium.dev/selenium-ide)_ (Integrated Development Environment = Entwicklungsumgebung)
32+
[IDE](https://selenium.dev/selenium-ide) (Integrated Development Environment = Entwicklungsumgebung)
3333
ist ein Werkzeug um Seleniumtests zu erstellen. Es ist eine einfach zu handhabende
3434
Erweiterung für Chrome und Firefox und in der Regel ist dies die effizienteste Weg
3535
um Testfälle zu erstellen. Benutzerinteraktionen werden aufgezeichnet mit Hilfe von
@@ -47,4 +47,4 @@ die automatische Ausführung serverseitig.
4747
go-html-template
4848
Sollen erstellte WebDriver-Tests in mehreren
4949
Browsern und Betriebssystemen ausgeführt werden,
50-
kann dafür "_[Grid]({{</* ref "/grid/_index.md" */>}})_" genutzt werden.
50+
kann dafür [Grid]({{</* ref "/grid/_index.md" */>}}) genutzt werden.

‎website_hugo_files/content/documentation/overview/_index.en.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ but it composes many tools.
1313
## WebDriver
1414

1515
If you are beginning with desktop website or mobile website test automation, then you
16-
are going to be using WebDriver APIs. _[WebDriver](/documentation/webdriver)_
16+
are going to be using WebDriver APIs. [WebDriver](/documentation/webdriver)
1717
uses browser automation APIs provided by browser vendors to control browser and
1818
run tests. This is as if a real user is operating the browser. Since
1919
WebDriver does not require its API to be compiled with application
@@ -23,7 +23,7 @@ same application which you push live.
2323

2424
## IDE
2525

26-
_[IDE](https://selenium.dev/selenium-ide)_ (Integrated Development Environment)
26+
[IDE](https://selenium.dev/selenium-ide) (Integrated Development Environment)
2727
is the tool you use to develop your Selenium test cases. It’s an easy-to-use Chrome
2828
and Firefox extension and is generally the most efficient way to develop
2929
test cases. It records the users' actions in the browser for you, using
@@ -42,4 +42,4 @@ executed by the remote end.
4242
After the development of the WebDriver tests, you may face
4343
the need of running your tests on multiple browser and
4444
operating system combinations.
45-
This is where _[Grid]({{</* ref "/grid/_index.md" */>}})_ comes into the picture.
45+
This is where [Grid]({{</* ref "/grid/_index.md" */>}}) comes into the picture.

0 commit comments

Comments
 (0)