SeleniumHQ/selenium-ide

Update command-line-runner documentation

Open

#1,597 opened on Mar 8, 2023

View on GitHub
聽(1 comment)聽(0 reactions)聽(0 assignees)JavaScript聽(1,315 stars)聽(417 forks)batch import
good first issuehelp wanted

Description

馃悰 Bug Report

The documentation, last updated 4 years ago (!!!) is out of date.

Most notably:

  • nodejs version requirement has been upgraded (I've seen a >= 14 somewhere, I think)
  • installing browser drivers through npm results in problems with node-manager (see #1594 )
  • the npm edgedriver package hasn't been updated since 2019 and doesn't work anymore. It's only a matter of time before the other packages are also abandoned for one reason or another.
  • IE is deprecated, seriously even we have abandoned it, it doesn't even work anymore and force-redirects me to Edge

I would suggest to instruct to download the drivers individually and setting the path to the driver in .side.yml or as command argument.

It would also be nice to have a complete .side.yml documentation.

To Reproduce

https://www.selenium.dev/selenium-ide/docs/en/introduction/command-line-runner

Contributor guide

Tech stack
nodejs
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic understanding of Selenium IDE command line runnerfamiliarity with Node.jsknowledge of npm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Update the command line runner documentation at https://github.com/SeleniumHQ/selenium ide/tree/gh pages/docs/en/introduction/command line runner. The issue highlights outdated information including Node.js version requirements, issues with npm driver installation, deprecated edgedriver package, and IE deprecation. Review the current documentation and update it to reflect the latest practices, such as downloading drivers individually and configuring via .side.yml. Also consider adding a complete .side.yml documentation section.
Update command-line-runner documentation 路 SeleniumHQ/selenium-ide#1597 | Good First Issue