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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[馃殌 Feature]: The first script should not use any unit test library. or assertion. #1369

Closed
pallavigitwork opened this issue Apr 28, 2023 · 10 comments
Labels
documentation Improvements or additions to documentation needs-decision

Comments

@pallavigitwork
Copy link
Member

Feature and motivation

The first script uses unit test library and assertion in the code example. This should be reconsidered. Someone who is new to Selenium, not for the purpose of testing, or even for the purpose of automation, may not understand the code.

@github-actions
Copy link
Contributor

@pallavigitwork, thank you for creating this issue. We will troubleshoot it as soon as we can.


Info for maintainers

Triage this issue by using labels.

If information is missing, add a helpful comment and then I-issue-template label.

If the issue is a question, add the I-question label.

If the issue is valid but there is no time to troubleshoot it, consider adding the help wanted label.

After troubleshooting the issue, please add the R-awaiting answer label.

Thank you!

@diemol
Copy link
Member

diemol commented Apr 28, 2023

I think it makes sense to have the first script with a test runner and assertion library because most of the people who come to Selenium, want to test.

However, the very first script that welcomes users to the docs is pure Selenium, https://www.selenium.dev/documentation/. So I wonder if that is a good compromise.

@pallavigitwork
Copy link
Member Author

There is a section beneath it which says test runner. Is it a good idea to have these scripts there? And this section which compiles all right steps without any unit test / assertion.

@titusfortner
Copy link
Member

That was my intent. To have the first example be executable without a test runner. Then to have a section for how to use it in a larger context.

@pallavigitwork
Copy link
Member Author

i think that would be helpful and maybe the right way to do it.

@asolntsev asolntsev added the documentation Improvements or additions to documentation label Sep 9, 2023
@asolntsev
Copy link
Contributor

@pallavigitwork Maybe you cold just submit a pull request with your vision how this documentation should look like?

@titusfortner I think we can close the issue (until we get a pull request).

@titusfortner
Copy link
Member

Yes, let's track the underlying concern on the other issue

@titusfortner titusfortner closed this as not planned Won't fix, can't repro, duplicate, stale Sep 9, 2023
@pallavigitwork
Copy link
Member Author

The issue 1367 and 1369 are not duplicate of each other. One was for the introduction part of the selenium page which i found more test oriented, a lot of content has changed since then. the other issue talks about the code example, provided in getting started in Selenium. Since the documentation content is undergoing change, and I believe Corina is looking into it. This appears better to me - https://www.selenium.dev/documentation/webdriver/. At the same time there are many hyperlinks which asks users to go to different pages. It appears a busy page. Thats what I feel. Simplifying it, and segregating Selenium from its usage in web test automation I think could be done, and and we can also add information about selenium webdriver ecosystem, as a section.

@titusfortner
Copy link
Member

We have the code, it's just a matter of where it gets used, which I think is the point of the other one. I do think that we should show how to execute selenium outside of a test runner, but the examples should get executed on our CI as part of a test runner, so it doesn't make sense to do more than just show that it can be done without it.

Also, I agree it's busy. I think this is the piece Corina and Alicia areworking on.

@pallavigitwork
Copy link
Member Author

Sure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation needs-decision
Projects
None yet
Development

No branches or pull requests

4 participants