Skip to content

Add docs with Git history #3

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

Merged
merged 104 commits into from
Oct 17, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
104 commits
Select commit Hold shift + click to select a range
747ca45
Adding draft version of the new docs site using Hugo (#237)
diemol Jul 16, 2019
e2eb179
Fixing base url (#238)
diemol Jul 16, 2019
6df1684
Migrating installation content to Hugo (#240)
diemol Jul 18, 2019
f21fcc9
Migrating "Get started with webdriver" to Hugo (#241)
diemol Jul 19, 2019
7572089
Renaming section and adjusting links (#242)
diemol Jul 21, 2019
8fb95dd
Adding initial WebDriver sections (#243)
diemol Jul 21, 2019
d9d7843
Adding remaining WebDriver sections (#244)
diemol Jul 22, 2019
4480e02
Adding Remote WebDriver section to Hugo (#246)
diemol Jul 22, 2019
d8c41d3
Adding Guidelines and Recommendations section to Hugo (#247)
diemol Jul 24, 2019
9e7def6
Adding Worst practices content to Hugo (#248)
diemol Jul 25, 2019
a34898d
Adding Grid content to Hugo (#249)
diemol Jul 25, 2019
17ea6fe
Adding Driver idiosyncrasies content to Hugo (#250)
diemol Jul 25, 2019
f18c113
Adding Support packages content to Hugo (#251)
diemol Jul 25, 2019
e0e063d
Adding front matter content to Hugo (#252)
diemol Jul 25, 2019
883bf4c
Fixing a few broken links in Hugo (#253)
diemol Jul 26, 2019
d04152e
Fix links docs (#254)
diemol Jul 26, 2019
8422cf3
Fixing tab order for code preview (#255)
diemol Jul 26, 2019
23ba782
Renaming directory (#257)
diemol Jul 27, 2019
19c9e19
Type of testing - md edition (#266)
TheTestLynx Jul 30, 2019
65b1fca
Javascript alert doc (#273)
harsha509 Jul 31, 2019
a8da28a
Modify: 1. Commenting note for proper rendering. 2. Updating code wit…
harsha509 Aug 1, 2019
7dd8ea5
Setting file structure to allow translations, starting with Spanish (…
diemol Aug 4, 2019
f4fb47b
Modifying shortcode to use gh token (#282)
diemol Aug 4, 2019
53d35bc
Moving info to menu, enabling translations (#283)
diemol Aug 4, 2019
0babe72
Fixing broken SFC link (#284)
diemol Aug 4, 2019
2f56431
Fix path (#286)
imba-tjd Aug 5, 2019
98aa199
Add Dutch translation (#288)
cambiph Aug 5, 2019
a8e944b
Adding contribution doc (#289)
diemol Aug 5, 2019
8d1ec48
Adding translation status note for Dutch (#290)
diemol Aug 6, 2019
922afc8
Fixing language name (#292)
diemol Aug 6, 2019
0c348f2
Update driver_specific_capabilities.en.md (#291)
adithyab94 Aug 6, 2019
6217a4f
Add additional Dutch translations (#297)
cambiph Aug 7, 2019
518e4f5
i18n: add zh-cn structure (#298)
liushilive Aug 7, 2019
bebb774
i18n: add structure for fr (#299)
Bredda Aug 7, 2019
ad2ca6d
Fixing color select element (#300)
diemol Aug 7, 2019
02166e2
Add additional zh-cn translations (#301)
liushilive Aug 8, 2019
320157c
Fix #302 (#303)
diemol Aug 8, 2019
47f0ffd
Add additional zh-cn translations (#304)
liushilive Aug 9, 2019
d796dfb
Add additional zh-cn translations (#305)
liushilive Aug 9, 2019
6b9b596
Add additional zh-cn translations (#306)
liushilive Aug 11, 2019
9e3a16a
Update _index.es.md (#307)
AlexAndradeNet Aug 11, 2019
ec7a464
Update CONTRIBUTING.es.md (#308)
AlexAndradeNet Aug 11, 2019
95043a8
Update _index.es.md (#309)
AlexAndradeNet Aug 11, 2019
8def6a9
Update _index.es.md (#312)
AlexAndradeNet Aug 11, 2019
407ebbe
Update about_this_documentation.es.md (#310)
AlexAndradeNet Aug 11, 2019
c980f18
Update _index.es.md (#315)
AlexAndradeNet Aug 11, 2019
cc60750
Fixing logo for other browsers and mobile, fix #294 (#332)
diemol Aug 12, 2019
8bc337b
Update on_test_automation.es.md (#311)
AlexAndradeNet Aug 12, 2019
f9b3bf1
Update _index.es.md (#325)
AlexAndradeNet Aug 12, 2019
3aa0bc2
Update the_selenium_project_and_tools.es.md (#313)
AlexAndradeNet Aug 13, 2019
c6a5b57
Update types_of_testing.es.md (#314)
AlexAndradeNet Aug 13, 2019
3d3ae20
Step6 -> Step7 (#334)
imba-tjd Aug 14, 2019
3e5b803
Update quick.es.md (#316)
AlexAndradeNet Aug 14, 2019
3abb55a
Update html-runner.es.md (#317)
AlexAndradeNet Aug 14, 2019
2e8b822
Update _index.es.md (#318)
AlexAndradeNet Aug 14, 2019
f81ab1b
Update browsers.es.md (#319)
AlexAndradeNet Aug 14, 2019
a875981
Update locating_elements.es.md (#320)
AlexAndradeNet Aug 14, 2019
67aa113
Update performing_actions_on_the_aut.es.md (#321)
AlexAndradeNet Aug 14, 2019
ca2f34b
Update third_party_drivers_and_plugins.es.md (#322)
AlexAndradeNet Aug 14, 2019
552ced8
Update driver_specific_capabilities.es.md (#323)
AlexAndradeNet Aug 14, 2019
1e1b962
Update installing_webdriver_binaries.es.md (#327)
AlexAndradeNet Aug 14, 2019
dcaecf2
Update shared_capabilities.es.md (#324)
AlexAndradeNet Aug 15, 2019
02bebc1
Update installing_selenium_libraries.es.md (#326)
AlexAndradeNet Aug 15, 2019
c100318
Update _index.es.md (#328)
AlexAndradeNet Aug 15, 2019
8fa8a4a
Update components_of_a_grid.es.md (#329)
AlexAndradeNet Aug 15, 2019
47c5749
Update purposes_and_main_functionalities.es.md (#330)
AlexAndradeNet Aug 15, 2019
b3c98e5
Update setting_up_your_own_grid.es.md (#331)
AlexAndradeNet Aug 15, 2019
c5b0010
i18n(fr): Some more translation (#337)
Bredda Aug 15, 2019
98a9096
Removing off topic link (#338)
diemol Aug 16, 2019
828d6a0
Fix issue #336 (#339)
diemol Aug 17, 2019
fa4fb24
Fixing link redirect when selecting language, fix #335 (#340)
diemol Aug 18, 2019
32fb293
Update: JS doc update (#343)
harsha509 Aug 19, 2019
24fd353
Modify: Updated code with async/await (#344)
harsha509 Aug 19, 2019
10d2616
Modify: Updated JS come sample to translated pages. (#345)
harsha509 Aug 20, 2019
22f0937
Extra Dutch translations (#346)
cambiph Aug 21, 2019
a8d52e4
Duplicate translation in two languages on the quick tour page. (#349)
Aug 23, 2019
5566568
Installing Standalone server page translation. (#350)
Aug 23, 2019
53884e0
Add: Adding initial documentation for keyboard events (JavaScript) (#…
harsha509 Aug 23, 2019
4cf35cf
Update: updating doc with missing # for sendKeys (#351)
harsha509 Aug 23, 2019
3055b9c
Understanding the components page translated (#353)
Aug 25, 2019
94eb724
Wrong file name into WebDriver folder (#355)
Aug 25, 2019
331f319
i18n add zh-cn structure (#356)
liushilive Aug 27, 2019
5e62142
Update: Updating sample code for java and JavaScript (#357)
harsha509 Aug 28, 2019
dedfba9
Add Japanese translation (#358)
miekof Aug 30, 2019
fceda3c
Updated alert & keyboard doc (#359)
harsha509 Aug 30, 2019
13ddae3
C # comment line syntax correction (#362)
ilhanoztozlu Sep 2, 2019
9e65d17
Web element writing with C # language. (#363)
ilhanoztozlu Sep 3, 2019
fc365a6
Updated Ruby sample code for webElement.md (#364)
harsha509 Sep 4, 2019
3ed110d
Updated Ruby sample code for waits document (#365)
harsha509 Sep 6, 2019
192916a
Updated ruby sample code for browser manipulation (#366)
harsha509 Sep 10, 2019
9530c56
Updating ruby sample code for browser manipulation (#367)
harsha509 Sep 11, 2019
8468865
Updated python and ruby code for browser manipulation (#368)
harsha509 Sep 12, 2019
3e595e8
Updated python sample code for browser manipulation (#369)
harsha509 Sep 14, 2019
4acfd6f
Add Japanese translation (#370)
miekof Sep 17, 2019
7380f6c
Updated ruby sample code for browser manipulation (#371)
harsha509 Sep 17, 2019
c436dfb
Updated ruby sample code for browser manipulation (#372)
harsha509 Sep 18, 2019
f0ea791
Update small things on website (#380)
Oct 2, 2019
c3084bd
browsers.zh-cn.md Chinese translation (#381)
948462448 Oct 13, 2019
eab58f8
Update Java Code for Explicit Wait example 2 (#383)
bongosway Oct 14, 2019
8df320c
Updating hugo-theme-learn theme (#384)
diemol Oct 14, 2019
d7b3175
Csharp examples (#387)
misiekofski Oct 15, 2019
b43bf84
Added C# examples (#382)
alenros Oct 15, 2019
9bc4742
Changed deprecated method call for FluentWait () (#388)
boris779 Oct 17, 2019
7fba288
TabDefinition
boris779 Oct 9, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 6 additions & 0 deletions docs_source_files/archetypes/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "{{ replace .Name "-" " " | title }}"
date: {{ .Date }}
draft: true
---

196 changes: 196 additions & 0 deletions docs_source_files/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,196 @@
baseURL = "https://seleniumhq.github.io/docs/site"
languageCode = "en-US"
defaultContentLanguage = "en"
# Force to have /en/my-page and /fr/my-page routes, even for default language.
defaultContentLanguageInSubdir= true

canonifyurls = "true"

title = "Documentation for Selenium"
theme = "hugo-theme-learn"
copyright = "2013-{year}"

# Code highlighting
pygmentsUseClasses = false
pygmentsCodeFences = true
pygmentsCodefencesGuessSyntax = true
pygmentsStyle = "solarized-dark"

enableGitInfo = true

[params]
# Change default color scheme with a variant one. Can be "red", "blue", "green".
themeVariant = "selenium"
editURL = "https://github.com/SeleniumHQ/docs/edit/gh-pages/docs_source_files/content/"
ghrepo = "https://github.com/SeleniumHQ/docs/"
description = "Documentation for Selenium"
showVisitedLinks = true
disableBreadcrumb = false
disableNextPrev = false

# For search functionality
[outputs]
home = [ "HTML", "RSS", "JSON"]

[Languages]
[Languages.en]
title = "Documentation for Selenium"
weight = 1
languageName = "English"
baseURL = "https://seleniumhq.github.io/docs/site/en"

[[Languages.en.menu.shortcuts]]
name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
identifier = "ds"
url = "https://github.com/SeleniumHQ/docs"
weight = 10

[[Languages.en.menu.shortcuts]]
name = "<i class='fas fa-fw fa-exclamation-triangle'></i> Report a bug"
url = "https://github.com/seleniumhq/docs/issues"
weight = 11

[[Languages.en.menu.shortcuts]]
name = "<i class='fas fa-fw fa-bullhorn'></i> Credits"
url = "front_matter/copyright_and_attributions"
weight = 20

[[Languages.en.menu.shortcuts]]
name = "<i class='fas fa-fw fa-bullhorn'></i> How to contribute"
url = "contributing"
weight = 30

[Languages.es]
title = "Documentación de Selenium"
weight = 2
languageName = "Español"
baseURL = "https://seleniumhq.github.io/docs/site/es"

[[Languages.es.menu.shortcuts]]
name = "<i class='fab fa-fw fa-github'></i> Repo en GitHub"
identifier = "ds"
url = "https://github.com/SeleniumHQ/docs"
weight = 10

[[Languages.es.menu.shortcuts]]
name = "<i class='fas fa-fw fa-exclamation-triangle'></i> Reportar un problema"
url = "https://github.com/seleniumhq/docs/issues"
weight = 11

[[Languages.es.menu.shortcuts]]
name = "<i class='fas fa-fw fa-bullhorn'></i> Créditos"
url = "front_matter/copyright_and_attributions"
weight = 20

[[Languages.es.menu.shortcuts]]
name = "<i class='fas fa-fw fa-bullhorn'></i> Cómo contribuír"
url = "contributing"
weight = 30

[Languages.nl]
title = "Selenium documentatie"
weight = 3
languageName = "Nederlands"
baseURL = "https://seleniumhq.github.io/docs/site/nl"

[[Languages.nl.menu.shortcuts]]
name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
identifier = "ds"
url = "https://github.com/SeleniumHQ/docs"
weight = 10

[[Languages.nl.menu.shortcuts]]
name = "<i class='fas fa-fw fa-exclamation-triangle'></i> Meld een probleem"
url = "https://github.com/seleniumhq/docs/issues"
weight = 11

[[Languages.nl.menu.shortcuts]]
name = "<i class='fas fa-fw fa-bullhorn'></i> Credits"
url = "front_matter/copyright_and_attributions"
weight = 20

[[Languages.nl.menu.shortcuts]]
name = "<i class='fas fa-fw fa-bullhorn'></i> Hoe bij te dragen"
url = "contributing"
weight = 30

[Languages.zh-cn]
title = "Selenium 文档"
weight = 4
languageName = "中文简体"
baseURL = "https://seleniumhq.github.io/docs/site/zh-cn"

[[Languages.zh-cn.menu.shortcuts]]
name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
identifier = "ds"
url = "https://github.com/SeleniumHQ/docs"
weight = 10

[[Languages.zh-cn.menu.shortcuts]]
name = "<i class='fas fa-fw fa-exclamation-triangle'></i> Report a bug"
url = "https://github.com/seleniumhq/docs/issues"
weight = 11

[[Languages.zh-cn.menu.shortcuts]]
name = "<i class='fas fa-fw fa-bullhorn'></i> Credits"
url = "front_matter/copyright_and_attributions"
weight = 20

[[Languages.zh-cn.menu.shortcuts]]
name = "<i class='fas fa-fw fa-bullhorn'></i> How to contribute"
url = "contributing"
weight = 30

[Languages.fr]
title = "Documentation Selenium"
weight = 5
languageName = "Français"
baseURL = "https://seleniumhq.github.io/docs/site/fr"

[[Languages.fr.menu.shortcuts]]
name = "<i class='fas fa-fw fa-exclamation-triangle'></i> Signaler un problème"
url = "https://github.com/seleniumhq/docs/issues"
weight = 11

[[Languages.fr.menu.shortcuts]]
name = "<i class='fas fa-fw fa-bullhorn'></i> Crédits"
url = "front_matter/copyright_and_attributions"
weight = 20

[[Languages.fr.menu.shortcuts]]
name = "<i class='fas fa-fw fa-bullhorn'></i> Comment contribuer"
url = "contributing"
weight = 30

[[Languages.fr.menu.shortcuts]]
name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
identifier = "ds"
url = "https://github.com/SeleniumHQ/docs"
weight = 10

[Languages.ja]
title = "Seleniumドキュメント"
weight = 6
languageName = "日本語"
baseURL = "https://seleniumhq.github.io/docs/site/ja"

[[Languages.ja.menu.shortcuts]]
name = "<i class='fab fa-fw fa-github'></i> GitHub リポ"
identifier = "ds"
url = "https://github.com/SeleniumHQ/docs"
weight = 10

[[Languages.ja.menu.shortcuts]]
name = "<i class='fas fa-fw fa-exclamation-triangle'></i> バグ報告"
url = "https://github.com/seleniumhq/docs/issues"
weight = 11

[[Languages.ja.menu.shortcuts]]
name = "<i class='fas fa-fw fa-bullhorn'></i> クレジット"
url = "front_matter/copyright_and_attributions"
weight = 20

[[Languages.ja.menu.shortcuts]]
name = "<i class='fas fa-fw fa-bullhorn'></i> 貢献方法"
url = "contributing"
weight = 30
190 changes: 190 additions & 0 deletions docs_source_files/content/CONTRIBUTING.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,190 @@
---
title: Contributing to the Selenium Documentation
disableToc: true
---

Selenium is a big software project and documentation is key to
understanding how things work and learning effective ways to exploit
its potential.

Part of the documentation of Selenium is still served from our
[**www.seleniumhq.org** repository](https://github.com/SeleniumHQ/www.seleniumhq.org).
We are however phasing out this documentation which focuses too much
on Selenium RC and other antiquated pieces, in favour of this rewrite.

The new documentation is a project started to rewrite Selenium's
documentation from scratch. This is an ongoing effort (not targetted
at any specific release) to provide an updated handbook on how to use
Selenium effectively. We hope to bring over the pieces of the old
documentation that makes sense.

Contributions toward the new docs follow the process described in
the below section about contributions. You should spend some time
familiarising yourself with the documentation by reading
[more about it]({{< ref "/introduction/about_this_documentation.en.md" >}}).

---

The Selenium project welcomes contributions from everyone. There are a
number of ways you can help:

## Report an issue

When reporting a new issues or commenting on existing issues please
make sure discussions are related to concrete technical issues with the
Selenium software and/or its documentation.

All of the Selenium components change quite fast over time, so this
might cause the documentation to be out of date. If you find this to
be the case, as mentioned, don't doubt to create an issue for that.
It also might be possible that you know how to bring up to date the
documentation, so please send us a pull request with the related
changes.

If you are not sure about what you have found is an issue or not,
please ask first about it to the
[selenium-users@ mailing list](https://groups.google.com/forum/#!forum/selenium-users),
or join us in the `#selenium` channel
on [irc.freenode.org](https://webchat.freenode.net/) or [Slack](https://seleniumhq.herokuapp.com/).

## Contributions

The Selenium project welcomes new contributors. Individuals making
significant and valuable contributions over time are made _Committers_
and given commit-access to the project.

This document will guide you through the contribution process.

### Step 1: Fork

Fork the project [on Github](https://github.com/seleniumhq/docs)
and check out your copy locally.

```shell
% git clone [email protected]:username/docs.git
% cd docs
% git remote add upstream git://github.com/seleniumhq/docs.git
```

#### Dependencies: Hugo

The docs use [Hugo](https://gohugo.io/) to build and render the site.
To verify everything locally before even commiting any changes, please
[install Hugo](https://gohugo.io/getting-started/installing/) and
[run the local server](https://gohugo.io/getting-started/usage/#livereload)
to render the site locally.

### Step 2: Branch

Create a feature branch and start hacking:

```shell
% git checkout -b my-feature-branch
```

We practice HEAD-based development, which means all changes are applied
directly on top of master.

### Step 3: Commit

First make sure git knows your name and email address:

```shell
% git config --global user.name 'Santa Claus'
% git config --global user.email '[email protected]'
```

**Writing good commit messages is important.** A commit message
should describe what changed, why, and reference issues fixed (if
any). Follow these guidelines when writing one:

1. The first line should be around 50 characters or less and contain a
short description of the change.
2. Keep the second line blank.
3. Wrap all other lines at 72 columns.
4. Include `Fixes #N`, where _N_ is the issue number the commit
fixes, if any.

A good commit message can look like this:

```text
explain commit normatively in one line

Body of commit message is a few lines of text, explaining things
in more detail, possibly giving some background about the issue
being fixed, etc.

The body of the commit message can be several paragraphs, and
please do proper word-wrap and keep columns shorter than about
72 characters or so. That way `git log` will show things
nicely even when it is indented.

Fixes #141
```

The first line must be meaningful as it's what people see when they
run `git shortlog` or `git log --oneline`.

### Step 4: Rebase

Use `git rebase` (not `git merge`) to sync your work from time to time.

```shell
% git fetch upstream
% git rebase upstream/master
```

### Step 5: Test

Always remember to [run the local server](https://gohugo.io/getting-started/usage/#livereload),
with this you can be safe that your changes have not broken anything.

### Step 6: Translations

If you are updating the docs, adding new ones, or deleting deprecated ones, please remember
to update the translations of it. Of course, it is possible that you do not speak all the
translated languages in the docs. For that, please create an
[issue](https://github.com/SeleniumHQ/docs/issues) where you clearly describe that something
in the docs has changed and its translation needs to be updated. With that, someone who speaks
that needed language can chime in and help us to keep it up to date.

### Step 7: Sign the CLA

Before we can accept, we first ask people to sign a
[Contributor License Agreement](https://spreadsheets.google.com/spreadsheet/viewform?hl=en_US&formkey=dFFjXzBzM1VwekFlOWFWMjFFRjJMRFE6MQ#gid=0)
(or CLA). We ask this so that we know that contributors have the right
to donate the code.

When you open your pull request we ask that you indicate that you've
signed the CLA. This will reduce the time it takes for us to integrate
it.

### Step 8: Push

```shell
% git push origin my-feature-branch
```

Go to https://github.com/yourusername/docs.git and press the _Pull
Request_ and fill out the form. **Please indicate that you've signed
the CLA** (see Step 7).

Pull requests are usually reviewed within a few days. If there are
comments to address, apply your changes in new commits (preferably
[fixups](http://git-scm.com/docs/git-commit)) and push to the same
branch.

### Step 9: Integration

When code review is complete, a committer will take your PR and
integrate it on the docs's gh-pages branch. Because we like to keep a
linear history on the master branch, we will normally squash and rebase
your branch history.

## Communication

Selenium contributors frequent the `#selenium` channel on
[`irc.freenode.org`](https://webchat.freenode.net/) or on
or [Slack](https://seleniumhq.herokuapp.com/). You can also join
the [`selenium-developers@` mailing list](https://groups.google.com/forum/#!forum/selenium-developers).

Loading