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 (417 forks)batch import
good first issuehelp wanted

Repository metrics

Stars
 (1,315 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Review the command line runner documentation page linked in the issue. Identify outdated sections and update them according to the suggestions: specify correct Node.js version, recommend downloading drivers individually and setting path in .side.yml, remove IE references, and add a full .side.yml documentation.
Tech stack
javascriptnodejs
Domain
clidocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80