-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Update Selenium Manager (beta) page #1454
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
Conversation
✅ Deploy Preview for selenium-dev ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
2385560 to
52c3707
Compare
52c3707 to
cab7311
Compare
iamalittletester
commented
Aug 16, 2023
It looks good to me generally but i would change a few things to better highlight some aspects:
- in the paragraph right after the title i would specify that this manages now comes out of the box, highlighting that the user doesn't need to do anything extra to get the manager (except to download Selenium obviously)
- in the Motivation section i would change the tense to past, to suggest that those actions (like downloading the driver, setting the path) are actions that users previously needed to do. Currently, when using the latest Selenium versions, the users don't need to do all those things. Also, in the last phrase of this section i would again emphasize that the manager comes out of the box, with the Selenium library.
- the above 2 lines are based on wanting to quickly make the users understand the basics and important aspects of the manager, rather than provide this information after many paragraphs
- in the Usage section, where you specify that the users can continue to manage their own drivers, or have this done automatically, i would inverse the order of these 2: we want to encourage the users to use the 'automated' mode, so we should put that as the first option in this paragraph
- in the Configuration section, i would start with when would a user need to do the setup mentioned in this section. Or maybe i understand it wrong, maybe it actually describes how the manager works under the hood. This is confusing i think, so maybe describe why the user needs to do what is described there or whether that's the inner workings of the manager
Thanks a lot, @iamalittletester, for your feedback. I have just committed a second patch to this PR reviewing the content according to your comments. Also, I have included several TL;DR paragraphs at the beginning of the main sections to highlight the main ideas.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall this is a great explanation. I made some specific comments about things I think should be added/changed.
Co-authored-by: Titus Fortner <titusfortner@users.noreply.github.com>
Co-authored-by: Titus Fortner <titusfortner@users.noreply.github.com>
Co-authored-by: Titus Fortner <titusfortner@users.noreply.github.com>
@titusfortner I have just committed a new path to this PR. I think everything (or most of it) should be fixed now.
* Update Selenium Manager (beta) page * Update SM page highlighting relevant ideas (TLDR) [deploy site] 59b6c4e
Description
This PR updates the English version of the Selenium Manager (beta) page.
Although some parts of this documentation are a bit lengthy, I recommend explaining it in detail to understand better Selenium Manager and its relationship with the rest of Selenium components. Also, specific examples made this page a bit longer, but I believe they help understand the presented concepts (e.g., driver management, caching, etc.).
Motivation and Context
This PR implements SeleniumHQ/selenium#11695 of the Selenium Manager project.
Types of changes
Checklist