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

[blog] Welcoming puppeteer to the webdriver world #1849

Merged
merged 3 commits into from
Aug 12, 2024
Merged

Conversation

AutomatedTester
Copy link
Member

@AutomatedTester AutomatedTester commented Aug 9, 2024

User description

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

Motivation and Context

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.

PR Type

Documentation


Description

  • Added a new blog post titled "Welcoming Puppeteer to the WebDriver World".
  • Announced Puppeteer's move to support WebDriver BiDi in Chromium and Firefox.
  • Highlighted the collaboration between Selenium and browser teams on the WebDriver-BiDi specification.
  • Included links to relevant documentation and external articles for more information.

Changes walkthrough 📝

Relevant files
Documentation
welcoming-puppeteer-to-the-webdriver-world.md
New blog post: Welcoming Puppeteer to WebDriver BiDi         

website_and_docs/content/blog/2024/welcoming-puppeteer-to-the-webdriver-world.md

  • Added a new blog post announcing Puppeteer's support for WebDriver
    BiDi.
  • Included links to WebDriver and WebDriver-BiDi specifications.
  • Provided context on the collaboration with browser teams.
  • Shared external resources for further reading.
  • +25/-0   

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    @qodo-merge-pro qodo-merge-pro bot added documentation Improvements or additions to documentation Review effort [1-5]: 1 labels Aug 9, 2024
    Copy link
    Contributor

    qodo-merge-pro bot commented Aug 9, 2024

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No key issues to review

    Copy link
    Contributor

    qodo-merge-pro bot commented Aug 9, 2024

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Readability
    Streamline content to enhance readability and flow

    To avoid redundancy and enhance the flow of the article, consider merging these two
    sentences into one cohesive statement.

    website_and_docs/content/blog/2024/welcoming-puppeteer-to-the-webdriver-world.md [19-20]

    -This new protocol allows us to be able to do things Selenium always wanted to do but was never surfaced to us in a
    -meaningful way. We have documented all the latest additions to Selenium, thanks to WebDriver-BiDi, in our [documentation](https://www.selenium.dev/documentation/webdriver/bidi/)
    +This new protocol enables Selenium to achieve previously unattainable goals, all documented in our latest [WebDriver-BiDi documentation](https://www.selenium.dev/documentation/webdriver/bidi/).
     
    • Apply this suggestion
    Suggestion importance[1-10]: 9

    Why: Merging the two sentences into one cohesive statement reduces redundancy and improves the flow of the article, making it more concise and readable.

    9
    Improve sentence clarity and readability by using active voice

    To enhance readability and maintain a consistent voice, consider rephrasing the
    sentence to avoid passive voice and clarify the subject.

    website_and_docs/content/blog/2024/welcoming-puppeteer-to-the-webdriver-world.md [16]

    -Puppeteer has moved over to using [WebDriver-BiDi](https://w3c.github.io/webdriver-bidi), the new WebDriver Specification
    +Puppeteer now uses [WebDriver-BiDi](https://w3c.github.io/webdriver-bidi), the new WebDriver Specification
     
    • Apply this suggestion
    Suggestion importance[1-10]: 8

    Why: Rephrasing the sentence to use active voice enhances readability and clarity, making the content more engaging and easier to understand.

    8
    Enhancement
    Refine the tagging strategy to improve content categorization and searchability

    Consider using a more specific tag than "selenium" to better categorize the content
    related to Puppeteer's integration with WebDriver BiDi. This will help in organizing
    the blog posts more efficiently and improve searchability.

    website_and_docs/content/blog/2024/welcoming-puppeteer-to-the-webdriver-world.md [5]

    -tags: ["selenium"]
    +tags: ["selenium", "puppeteer", "webdriver-bidi"]
     
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: Adding more specific tags like "puppeteer" and "webdriver-bidi" improves the categorization and searchability of the blog post. This is a minor enhancement but beneficial for content organization.

    7
    Clarity
    Specify the type of teams involved to enhance clarity

    To ensure accuracy and clarity, consider specifying which teams from Safari, Edge,
    Chrome, and Firefox were involved, as "teams" is quite vague.

    website_and_docs/content/blog/2024/welcoming-puppeteer-to-the-webdriver-world.md [14]

    -with the Safari, Edge, Chrome, and Firefox teams on the [WebDriver-BiDi specification](https://w3c.github.io/webdriver-bidi).
    +with the development teams from Safari, Edge, Chrome, and Firefox on the [WebDriver-BiDi specification](https://w3c.github.io/webdriver-bidi).
     
    • Apply this suggestion
    Suggestion importance[1-10]: 6

    Why: Specifying "development teams" instead of just "teams" adds clarity, although the original text is already understandable. This is a minor improvement for precision.

    6

    Copy link

    netlify bot commented Aug 9, 2024

    Deploy Preview for selenium-dev ready!

    Name Link
    🔨 Latest commit 6ee9057
    🔍 Latest deploy log https://app.netlify.com/sites/selenium-dev/deploys/66b99e25a1dd69000836fc9a
    😎 Deploy Preview https://deploy-preview-1849--selenium-dev.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 configuration.

    Copy link
    Member

    @harsha509 harsha509 left a comment

    Choose a reason for hiding this comment

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

    Thank you @AutomatedTester !

    @harsha509 harsha509 merged commit 1c56374 into trunk Aug 12, 2024
    6 checks passed
    @harsha509 harsha509 deleted the pptr-bidi branch August 12, 2024 05:41
    selenium-ci added a commit that referenced this pull request Aug 12, 2024
    * [blog] Welcoming puppeteer to the webdcriver world
    
    * Update with review comments
    
    ---------
    
    Co-authored-by: Sri Harsha <[email protected]> 1c56374
    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 Review effort [1-5]: 1
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants