-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Broken Links #1612
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
Broken Links #1612
Conversation
this allows us to keep historical reference without broken links
✅ Deploy Preview for selenium-dev ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
PR Description updated to latest commit (280b026)
- Copy walkthrough table to "Files Changed" Tab
PR Review
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.
No
No
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:
/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...
With a configuration file, use the following template:
[pr_reviewer]
some_config1=...
some_config2=...
Utilizing extra instructions
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
reviewtool 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 issuelabel, that detects possible security issues (enable_review_labels_securityflag) - a
Review effort [1-5]: xlabel, where x is the estimated effort to review the PR (enable_review_labels_effortflag)
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.
- /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
- /ask <QUESTION>: Ask a question about the PR.
- /update_changelog: Update the changelog based on the PR's contents.
- /add_docs 💎: Generate docstring for new components introduced in the PR.
- /generate_labels 💎: Generate labels for the PR based on the PR's contents.
- /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.
See the tools guide for more details.
To list the possible configuration parameters, add a /config comment.
See the review usage page for a comprehensive guide on using this tool.
PR Code Suggestions
✨ Improve tool usage guide:Overview: With a configuration file, use the following template: Enabling\disabling automationWhen you first install the app, the default mode for the improve tool is: meaning the Utilizing extra instructionsExtra instructions are very important for the 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: Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable. A note on code suggestions quality
More PR-Agent commands
See the improve usage page for a more comprehensive guide on using this tool. |
280b026 to
1696a28
Compare
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.
Thank you @titusfortner !
* 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 <12621691+harsha509@users.noreply.github.com> c73064b
Uh oh!
There was an error while loading. Please reload this page.
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