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

Feature/documentation update #435

Merged
merged 7 commits into from
Jul 18, 2024
Merged

Conversation

TobiasAdler
Copy link
Collaborator

@TobiasAdler TobiasAdler commented Jul 8, 2024

Description

Some sections of the documentation are outdated, for example due to the new Selenium Manager feature.

  • Replaced local webdriver warning with a simple info, since the warning about side effects is no longer relevant
  • Updated the doc sections for local execution
  • Added a link to a Selenium issue regarding the usage of different scalings
  • Added note for configfailurepolicy
  • Fixed some typos

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@TobiasAdler TobiasAdler marked this pull request as ready for review July 9, 2024 06:12
----

TIP: All defined properties can be overwritten later by adding system parameters to your command. +
(e.a `-D{browser_setting}=firefox`)

All supported browsers are listed in <<WebdriverManager properties>>

The tests will be started using the browser that is installed on the local machine if you do not provide a version in the properties.
If you want to use a specific browser version that is not installed, Selenium Manager will automatically download the required version of Firefox or Chrome in the background if you add your desired version to the properties.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The additional note if you add your desired version to the properties can be removed, it's doublicate.

== Setup Selenium
== Setup Selenium (optional)

You do not have to set up a web driver manually, as the Selenium Manager automatically handles the download of the drivers.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first sentence seems to be doublicate. Selenium Manager is already mentioned some lines above.

@@ -35,7 +35,8 @@ The following prerequisites must be met

. Concrete execution environment: Layout tests should run in a concrete browser environment to ensure the comparability of the screenshots.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please, can you fix the list of prerequisites? The first point is marked with ., all other with **. But imho all points have the same priority and level.
All points should only have - as list sign.

=== Manually configure WebDriver binaries

- Search for your browser's Selenium driver online, like _selenium gecko driver_ for Firefox or _selenium crome driver_ for Chrome based browsers
- Search for your browser's Selenium driver online, like _selenium gecko driver_ for Firefox or _selenium chrome driver_ for Chrome based browsers
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this information is not needed for Testerra users.

@martingrossmann martingrossmann merged commit 2c9a9f6 into master Jul 18, 2024
@martingrossmann martingrossmann deleted the feature/documentation_update branch July 18, 2024 06:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants