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

Provide Mocha install instructions to run first JS script #1185

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

dublinsubway
Copy link

Thanks for contributing to the Selenium site and documentation!
A PR well described will help maintainers to review and merge it quickly

Before submitting your PR, please check our contributing guidelines.
Avoid large PRs, and help reviewers by making them as simple and short as possible.

Description

Add a line explaining the way to run their script as it might not be clear for beginners. Closes #1160.

Motivation and Context

Providing people with a bit more detailed information about the way they can run their first test script locally.

Types of changes

  • Change to the site (I have double-checked the Netlify deployment, and my changes look good)
  • Code example added (and I also added the example to all translated languages)
  • Improved translation
  • Added new translation (and I also added a notice to each document missing translation)

Checklist

  • I have read the contributing document.
  • I have used hugo to render the site/docs locally and I am sure it works.

@CLAassistant
Copy link

CLAassistant commented Sep 30, 2022

CLA assistant check
All committers have signed the CLA.

@netlify
Copy link

netlify bot commented Sep 30, 2022

Deploy Preview for jovial-austin-42fe02 ready!

Name Link
🔨 Latest commit 831f720
🔍 Latest deploy log https://app.netlify.com/sites/jovial-austin-42fe02/deploys/633771b852415c0009d564ad
😎 Deploy Preview https://deploy-preview-1185--jovial-austin-42fe02.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Copy link
Member

@titusfortner titusfortner left a comment

Choose a reason for hiding this comment

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

First, thanks for this PR.

The goal of the "first script" page is to try to demonstrate the minimum necessary for executing Selenium code. I think the right answer here is to create a new page in Getting Started Section for "Scaling Selenium" or "Test Runners" or something. Let's discuss in #documentation channel and see where we want to take this.

@titusfortner titusfortner dismissed their stale review October 3, 2022 15:45

discuss in Slack...

@diemol
Copy link
Member

diemol commented Nov 1, 2022

What was the conclusion of the discussion?

@harsha509
Copy link
Member

I have created a section for Test Runners in here https://www.selenium.dev/documentation/webdriver/getting_started/first_script/#test-runners

But needs a decision on this too!

@diemol
Copy link
Member

diemol commented Nov 14, 2022

That section probably makes sense, but I would leave it in a different page and link it from the First Script page, as it is now, it can confuse more than clarify.

@titusfortner
Copy link
Member

I think what we want to do is to create a separate test_runners.md docs file where we discuss why you would use a test runner, list the various options in each language, and then show code for the ones we're using in examples/

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.

[JS]: Missing documentation on running the firstscript.spec.js
5 participants