You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some links are broken due to incorrect syntax, some links have changed location, some are no longer valid and I've changed them to be marked as code instead of URL to maintain historical reference without indicating a link.
Might be a better way to do it.
Type
documentation, enhancement
Description
Updated broken links across multiple blog posts to be marked as code instead of URLs.
Fixed broken links in blog posts, documentation, and meeting notes.
Corrected references to documentation and APIs in blog posts.
Removed GitHub profile links from meeting notes.
Changes walkthrough
Relevant files
Enhancement
23 files
going-atomic-how.md
Update Links and Improve Code Reference Formatting in Blog Post
1, because the PR is primarily focused on updating documentation and meeting notes, which are straightforward to review. The changes involve link corrections and formatting adjustments, which are not complex.
🧪 Relevant tests
No
🔍 Possible issues
No
🔒 Security concerns
No
✨ Review tool usage guide:
Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:
The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.
Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.
Examples for extra instructions:
[pr_reviewer] # /review #
extra_instructions="""
In the 'possible issues' section, emphasize the following:
- Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand?
- Is the code logic efficient?
...
"""
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
How to enable\disable automation
When you first install PR-Agent app, the default mode for the review tool is:
pr_commands = ["/review", ...]
meaning the review tool will run automatically on every PR, with the default configuration.
Edit this field to enable/disable the tool, or to change the used configurations
Auto-labels
The review tool can auto-generate two specific types of labels for a PR:
a possible security issue label, that detects possible security issues (enable_review_labels_security flag)
a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)
Extra sub-tools
The review tool provides a collection of possible feedbacks about a PR.
It is recommended to review the possible options, and choose the ones relevant for your use case.
Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: require_score_review, require_soc2_ticket, require_can_be_split_review, and more.
Auto-approve PRs
By invoking:
/review auto_approve
The tool will automatically approve the PR, and add a comment with the approval.
To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following:
[pr_reviewer]
enable_auto_approval = true
(this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository)
You can also enable auto-approval only if the PR meets certain requirements, such as that the estimated_review_effort is equal or below a certain threshold, by adjusting the flag:
[pr_reviewer]
maximal_review_effort = 5
More PR-Agent commands
To invoke the PR-Agent, add a comment using one of the following commands:
/review: Request a review of your Pull Request.
/describe: Update the PR title and description based on the contents of the PR.
-Selenium 1’s getAttribute (`http://selenium.googlecode.com/svn/trunk/docs/api/java/com/thoughtworks/selenium/Selenium.html#getAttribute(java.lang.String)`) method only returns the value of a particular attribute, whereas WebDriver’s getAttribute (`http://selenium.googlecode.com/svn/trunk/docs/api/java/org/openqa/selenium/WebElement.html#getAttribute(java.lang.String`)) method will return the value of either a property or an attribute+Selenium 1’s getAttribute (`https://selenium.googlecode.com/svn/trunk/docs/api/java/com/thoughtworks/selenium/Selenium.html#getAttribute(java.lang.String)`) method only returns the value of a particular attribute, whereas WebDriver’s getAttribute (`https://selenium.googlecode.com/svn/trunk/docs/api/java/org/openqa/selenium/WebElement.html#getAttribute(java.lang.String`)) method will return the value of either a property or an attribute
Enhancement
Correct markdown link syntax for readability and navigation.
Correct the syntax of the markdown links to ensure they are properly formatted and clickable.
-ExpectedConditions (`http://selenium.googlecode.com/svn/trunk/docs/api/java/org/openqa/selenium/support/ui/ExpectedConditions.html) class that supplies many useful criteria+ExpectedConditions ([`http://selenium.googlecode.com/svn/trunk/docs/api/java/org/openqa/selenium/support/ui/ExpectedConditions.html`]) class that supplies many useful criteria
Convert direct URLs to markdown link format for better readability.
Replace the direct URL with a markdown link format for better readability and consistency with the previous format. This will make the document more user-friendly and maintainable.
-* New APIs for dealing with HTML5 elements (`http://selenium.googlecode.com/svn/trunk/docs/api/java/org/openqa/selenium/html5/package-summary.html`) (best implemented, for now, by the mobile webdrivers)+* New APIs for dealing with HTML5 elements [org.openqa.selenium.html5 package summary](http://selenium.googlecode.com/svn/trunk/docs/api/java/org/openqa/selenium/html5/package-summary.html) (best implemented, for now, by the mobile webdrivers)
Use markdown link format for URLs to improve document readability.
Convert the direct URLs to markdown link format to maintain consistency and improve the readability of the document.
-Although we have a mechanism available (`http://selenium.googlecode.com/svn/trunk/docs/api/java/org/openqa/selenium/JavascriptExecutor.html`) in every browser for executing JS, it’s wildly inefficient to dump an enormous lump of code on to the JS engine of the browser whenever you want to query the DOM.+Although we have a mechanism available [org.openqa.selenium.JavascriptExecutor](http://selenium.googlecode.com/svn/trunk/docs/api/java/org/openqa/selenium/JavascriptExecutor.html) in every browser for executing JS, it’s wildly inefficient to dump an enormous lump of code on to the JS engine of the browser whenever you want to query the DOM.
Convert direct URLs to markdown links for improved readability.
Replace the direct URL with markdown link format to enhance the document's readability and maintain consistency.
-As a result, for those browsers that support it, you can execute Javascript by casting the WebDriver instance to a JavascriptExecutor (`http://selenium.googlecode.com/svn/trunk/docs/api/java/org/openqa/selenium/JavascriptExecutor.html`).+As a result, for those browsers that support it, you can execute Javascript by casting the WebDriver instance to a [JavascriptExecutor](http://selenium.googlecode.com/svn/trunk/docs/api/java/org/openqa/selenium/JavascriptExecutor.html).
Improve link description for better accessibility and context.
Consider updating the GitHub Actions workflow link to use a more descriptive text than just "GitHub Actions workflow". This can improve accessibility and provide more context to the reader.
-Selenium Manager is compiled using a [GitHub Actions workflow](https://github.com/SeleniumHQ/selenium/actions/workflows/ci-rust.yml).+Selenium Manager is compiled using a GitHub Actions workflow, which you can view and download the binaries from [here](https://github.com/SeleniumHQ/selenium/actions/workflows/ci-rust.yml).
Replace direct download link with a link to the download page for context.
Replace the direct link to the downloadable file with a link to the download page or repository to provide context and additional options to the user.
-You can download it now (`http://selenium.googlecode.com/files/selenium-remote-control-1.0.3.zip`).+You can download it from our [releases page](https://github.com/SeleniumHQ/selenium/releases).
Best practice
Use angle brackets for URLs in markdown for correct link parsing.
Enclose URLs in markdown links with angle brackets (< and >) to ensure they are correctly interpreted as links by markdown parsers.
-alerts, prompts and confirms (`http://selenium.googlecode.com/svn/trunk/docs/api/java/org/openqa/selenium/WebDriver.TargetLocator.html#alert()`).+alerts, prompts and confirms (`<http://selenium.googlecode.com/svn/trunk/docs/api/java/org/openqa/selenium/WebDriver.TargetLocator.html#alert()>`).
Standardize hyperlink markdown formatting for consistency.
Ensure consistency in hyperlink markdown formatting across the document to improve readability and navigation.
-The deprecated RenderedWebElement interface has now been removed. Most of the functionality has been moved to either WebElement (`http://selenium.googlecode.com/svn/trunk/docs/api/java/org/openqa/selenium/WebElement.html`) or to the Actions (`http://selenium.googlecode.com/svn/trunk/docs/api/java/org/openqa/selenium/interactions/Actions.html`) class.+The RenderedWebElement interface has been removed. Its functionality is now available in the WebElement (`http://selenium.googlecode.com/svn/trunk/docs/api/java/org/openqa/selenium/WebElement.html`) and Actions (`http://selenium.googlecode.com/svn/trunk/docs/api/java/org/openqa/selenium/interactions/Actions.html`) classes.
Update or remove the outdated Google Code link.
Update the outdated Google Code link to a more current resource or remove it if it's no longer relevant, as Google Code has been archived.
-Development will continue to use Google Code’s (`http://selenium.googlecode.com/`) code hosting and issue tracking.+Development has moved to GitHub, and you can follow our progress on our [GitHub repository](https://github.com/SeleniumHQ/selenium).
Update SVN link to current documentation or API reference.
Replace the direct link to the SVN repository with a link to the corresponding documentation or API reference on a more current platform like GitHub.
-One thing you might appreciate is better exceptions (`http://selenium.googlecode.com/svn/trunk/docs/api/java/org/openqa/selenium/IllegalLocatorException.html`) being thrown when xpath searches return something other than a web element.+One thing you might appreciate is better exceptions, as detailed in our [API documentation](https://www.selenium.dev/selenium/docs/api/java/org/openqa/selenium/IllegalLocatorException.html).
Update the Selenium project link to a current website or repository.
Update the link to the Selenium project to point to a current and active website or repository, as Google Code has been archived.
-When the Selenium (`http://selenium.googlecode.com/`) and WebDriver projects merged, all those moons ago, we moved the infrastructure from something we hosted to Google Code.+When the Selenium and WebDriver projects merged, we moved the infrastructure to our [GitHub repository](https://github.com/SeleniumHQ/selenium).
Possible issue
Correct URL format for proper accessibility.
Correct the URL format by removing the extra parentheses to ensure the link is properly formatted and accessible.
-- From the build workflow. Selenium Manager is compiled using a [GitHub Actions workflow](https://github.com/SeleniumHQ/selenium/actions/workflows/ci-rust.yml). This workflow creates binaries for Windows, Linux, and macOS. You can download these binaries from these workflow executions.+- From the build workflow. Selenium Manager is compiled using a GitHub Actions workflow (`https://github.com/SeleniumHQ/selenium/actions/workflows/ci-rust.yml`). This workflow creates binaries for Windows, Linux, and macOS. You can download these binaries from these workflow executions.
Update the outdated and insecure URL to the correct and secure location of the Selenium project's source code.
The URL http://selenium.googlecode.com/ is using the insecure HTTP protocol. Given that Google Code has been shut down and redirects to HTTPS URLs, it's likely that this URL is outdated or incorrect. It's important to verify the current status of the Selenium project's source code hosting and update this URL to a secure and accurate location. If the project is now hosted on GitHub or another platform, provide the correct HTTPS URL to ensure users are directed to the right place without security warnings.
-Although the canonical source will be on Google Code (`http://selenium.googlecode.com/`), we’re working on setting up a github mirror. We’ll announce the location of that once it’s set up.+Although the canonical source will be on [GitHub](https://github.com/seleniumhq/selenium) (or the current hosting platform), we’re working on setting up additional mirrors. We’ll announce the locations of those once they’re set up.
✨ Improve tool usage guide:
Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:
meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.
Utilizing extra instructions
Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project.
Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on.
Examples for extra instructions:
[pr_code_suggestions] # /improve #
extra_instructions="""
Emphasize the following aspects:
- Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand?
- Is the code logic efficient?
...
"""
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
A note on code suggestions quality
While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base.
Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool
With large PRs, best quality will be obtained by using 'improve --extended' mode.
More PR-Agent commands
To invoke the PR-Agent, add a comment using one of the following commands:
/review: Request a review of your Pull Request.
/describe: Update the PR title and description based on the contents of the PR.
* annotate references to googlecode so they are not parsed as valid url
this allows us to keep historical reference without broken links
* fix broken links
---------
Co-authored-by: Sri Harsha <[email protected]> c73064b
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
Some links are broken due to incorrect syntax, some links have changed location, some are no longer valid and I've changed them to be marked as code instead of URL to maintain historical reference without indicating a link.
Might be a better way to do it.
Type
documentation, enhancement
Description
Changes walkthrough
23 files
going-atomic-how.md
Update Links and Improve Code Reference Formatting in Blog Postwebsite_and_docs/content/blog/2010/going-atomic-how.md
getAttributemethods tobe marked as code instead of URL.
going-atomic-why.md
Correct Broken Link Reference in Blog Postwebsite_and_docs/content/blog/2010/going-atomic-why.md
JavascriptExecutor.htmlto be marked as codeinstead of URL.
selenium-1-0-2-release-firefox-3-6-and-snow-leopard-support.md
Update Download Link Reference in Blog Postwebsite_and_docs/content/blog/2010/selenium-1-0-2-release-firefox-3-6-and-snow-leopard-support.md
selenium-remote-control-1.0.2.zipto bemarked as code instead of URL.
selenium-1-0-3-released.md
Update Download Link Reference in Blog Postwebsite_and_docs/content/blog/2010/selenium-1-0-3-released.md
selenium-remote-control-1.0.3.zipto bemarked as code instead of URL.
selenium-2-0-beta-1-release.md
Correct Documentation References in Blog Postwebsite_and_docs/content/blog/2010/selenium-2-0-beta-1-release.md
marked as code instead of URLs.
selenium-2-0a5-released.md
Update API References in Blog Postwebsite_and_docs/content/blog/2010/selenium-2-0a5-released.md
instead of URLs.
selenium-2-0a6-released.md
Update API References in Blog Postwebsite_and_docs/content/blog/2010/selenium-2-0a6-released.md
marked as code instead of URLs.
bug-bash.md
Correct Project Reference in Blog Postwebsite_and_docs/content/blog/2011/bug-bash.md
code instead of URL.
selenium-2-0b2-released.md
Update Documentation References in Blog Postwebsite_and_docs/content/blog/2011/selenium-2-0b2-released.md
code instead of URLs.
selenium-2-0b3-the-next-gen-browser-release.md
Update Download Link Reference in Blog Postwebsite_and_docs/content/blog/2011/selenium-2-0b3-the-next-gen-browser-release.md
android-server-2.0b3.apkto be marked ascode instead of URL.
selenium-2-0rc1-the-grid-release.md
Correct API Reference in Blog Postwebsite_and_docs/content/blog/2011/selenium-2-0rc1-the-grid-release.md
code instead of URLs.
selenium-2-0rc3-the-next-ones-the-big-one-release.md
Update Method References in Blog Postwebsite_and_docs/content/blog/2011/selenium-2-0rc3-the-next-ones-the-big-one-release.md
as code instead of URLs.
selenium-2-1-released.md
Correct Mailing List Link in Blog Postwebsite_and_docs/content/blog/2011/selenium-2-1-released.md
selenium-2-2-released.md
Update Documentation Reference in Blog Postwebsite_and_docs/content/blog/2011/selenium-2-2-released.md
code instead of URL.
selenium-2-3-released.md
Correct Source Tree Reference in Blog Postwebsite_and_docs/content/blog/2011/selenium-2-3-released.md
URL.
selenium-2-6-released.md
Update Class References in Blog Postwebsite_and_docs/content/blog/2011/selenium-2-6-released.md
classes to be marked as code instead of URLs.
selenium-2-8-released.md
Update Method Reference in Blog Postwebsite_and_docs/content/blog/2011/selenium-2-8-released.md
code instead of URL.
selenium-joins-the-software-freedom-conservancy.md
Correct Project Reference in Blog Postwebsite_and_docs/content/blog/2011/selenium-joins-the-software-freedom-conservancy.md
instead of URL.
a-smattering-of-selenium-90.md
Update Talk Reference in Blog Postwebsite_and_docs/content/blog/2012/a-smattering-of-selenium-90.md
instead of URL.
selenium-2-16-released-welcome-to-2012.md
Correct Changelog Reference in Blog Postwebsite_and_docs/content/blog/2012/selenium-2-16-released-welcome-to-2012.md
URL.
source-control.md
Correct Project Reference in Blog Postwebsite_and_docs/content/blog/2013/source-control.md
instead of URL.
faq.en.md
Update Documentation References in FAQwebsite_and_docs/content/documentation/legacy/selenium_2/faq.en.md
marked as code instead of URLs.
joint-03-31.md
Remove GitHub Profile Links from Meeting Noteswebsite_and_docs/content/meetings/2023/joint-03-31.md
11 files
selenium-hangout-2-recap.md
Fix Broken Link in Blog Post Recapwebsite_and_docs/content/blog/2013/selenium-hangout-2-recap.md
announcing-selenium-4.md
Fix Broken Documentation Links in Announcementwebsite_and_docs/content/blog/2021/announcing-selenium-4.md
authentication, JavaScript exceptions, and mutation observation.
selenium-4-beta-1.md
Fix Broken Link to TLC Section in Blog Postwebsite_and_docs/content/blog/2021/selenium-4-beta-1.md
selenium_manager.en.md
Fix Broken Link to GitHub Actions Workflowwebsite_and_docs/content/documentation/selenium_manager.en.md
selenium_manager.ja.md
Fix Broken Link to GitHub Actions Workflowwebsite_and_docs/content/documentation/selenium_manager.ja.md
selenium_manager.pt-br.md
Fix Broken Link to GitHub Actions Workflowwebsite_and_docs/content/documentation/selenium_manager.pt-br.md
selenium_manager.zh-cn.md
Fix Broken Link to GitHub Actions Workflowwebsite_and_docs/content/documentation/selenium_manager.zh-cn.md
remote_webdriver.en.md
Fix Broken Link to Browser Documentationwebsite_and_docs/content/documentation/webdriver/drivers/remote_webdriver.en.md
remote_webdriver.ja.md
Fix Broken Link to Browser Documentationwebsite_and_docs/content/documentation/webdriver/drivers/remote_webdriver.ja.md
remote_webdriver.pt-br.md
Fix Broken Link to Browser Documentationwebsite_and_docs/content/documentation/webdriver/drivers/remote_webdriver.pt-br.md
remote_webdriver.zh-cn.md
Fix Broken Link to Browser Documentationwebsite_and_docs/content/documentation/webdriver/drivers/remote_webdriver.zh-cn.md