Skip to content

[grid] update list CLI/TOML options#1683

Merged
diemol merged 1 commit intoSeleniumHQ:trunkfrom
NDViet:trunk
Apr 23, 2024
Merged

[grid] update list CLI/TOML options#1683
diemol merged 1 commit intoSeleniumHQ:trunkfrom
NDViet:trunk

Conversation

@VietND96
Copy link
Copy Markdown
Member

@VietND96 VietND96 commented Apr 22, 2024 •
edited by qodo-code-review Bot
Loading

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

Update docs for PR SeleniumHQ/selenium#13849

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.

Type

enhancement, documentation

Description

  • Added a new CLI option --service-protocol-version across multiple language documents to enforce specific HTTP protocol versions in HttpClient.
  • Introduced a new TOML configuration protocol-version in various language documents to specify the HTTP protocol version for service status communication.

Changes walkthrough

Relevant files
Enhancement
cli_options.en.md
Add new CLI option for protocol version enforcement           

website_and_docs/content/documentation/grid/configuration/cli_options.en.md

  • Added a new CLI option --service-protocol-version to enforce specific
    protocol versions in HttpClient.
    		•  +1/-0     
    cli_options.ja.md
    Add new CLI option for protocol version enforcement           

    website_and_docs/content/documentation/grid/configuration/cli_options.ja.md

  • Added a new CLI option --service-protocol-version to enforce specific
    protocol versions in HttpClient.
    		•  +1/-0     
    cli_options.pt-br.md
    Add new CLI option for protocol version enforcement           

    website_and_docs/content/documentation/grid/configuration/cli_options.pt-br.md

  • Added a new CLI option --service-protocol-version to enforce specific
    protocol versions in HttpClient.
    		•  +1/-0     
    cli_options.zh-cn.md
    Add new CLI option for protocol version enforcement           

    website_and_docs/content/documentation/grid/configuration/cli_options.zh-cn.md

  • Added a new CLI option --service-protocol-version to enforce specific
    protocol versions in HttpClient.
    		•  +1/-0     
    toml_options.en.md
    Add new TOML configuration for protocol version specification

    website_and_docs/content/documentation/grid/configuration/toml_options.en.md

  • Added a new TOML configuration protocol-version to specify protocol
    versions in HttpClient.
    		•  +2/-0     
    toml_options.ja.md
    Add new TOML configuration for protocol version specification

    website_and_docs/content/documentation/grid/configuration/toml_options.ja.md

  • Added a new TOML configuration protocol-version to specify protocol
    versions in HttpClient.
    		•  +2/-0     
    toml_options.pt-br.md
    Add new TOML configuration for protocol version specification

    website_and_docs/content/documentation/grid/configuration/toml_options.pt-br.md

  • Added a new TOML configuration protocol-version to specify protocol
    versions in HttpClient.
    		•  +2/-0     
    toml_options.zh-cn.md
    Add new TOML configuration for protocol version specification

    website_and_docs/content/documentation/grid/configuration/toml_options.zh-cn.md

  • Added a new TOML configuration protocol-version to specify protocol
    versions in HttpClient.
    		•  +2/-0     

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

    @netlify
    Copy link
    Copy Markdown

    netlify Bot commented Apr 22, 2024

    👷 Deploy request for selenium-dev pending review.

    Visit the deploys page to approve it

    Name Link
    🔨 Latest commit 4d7a832

    @qodo-code-review qodo-code-review Bot added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 22, 2024
    @qodo-code-review
    Copy link
    Copy Markdown
    Contributor

    qodo-code-review Bot commented Apr 22, 2024

    PR Description updated to latest commit (4d7a832)

    @qodo-code-review
    Copy link
    Copy Markdown
    Contributor

    qodo-code-review Bot commented Apr 22, 2024

    PR Review

    ⏱️ Estimated effort to review [1-5]

    2, because the PR involves straightforward documentation updates across multiple language files, adding a new CLI and TOML option. The changes are consistent and repetitive across different language versions, making it relatively easy to review.

    🧪 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 which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.

    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=...

    [pr_reviewer]
some_config1=...
some_config2=...

    See the review usage page for a comprehensive guide on using this tool.

    @qodo-code-review
    Copy link
    Copy Markdown
    Contributor

    qodo-code-review Bot commented Apr 22, 2024

    PR Code Suggestions

    CategorySuggestions                                                                                                                                                       
    Enhancement
    Add support for multiple HTTP protocol versions.

    Consider specifying additional protocol versions such as HTTP/2 alongside HTTP/1.1 for the
    --service-protocol-version option, to provide flexibility and support for more modern HTTP
    versions.

    website_and_docs/content/documentation/grid/configuration/cli_options.en.md [240]

    -| `--service-protocol-version` | string | `HTTP/1.1` | Optional, enforce a specific protocol version in HttpClient when communicating with the endpoint service status |
+| `--service-protocol-version` | string | `HTTP/1.1, HTTP/2` | Optional, enforce specific protocol versions in HttpClient when communicating with the endpoint service status |
    Clarification
    Clarify the comment to indicate support for multiple HTTP protocol versions.

    Include an example for HTTP/2 in the comment to clarify that multiple protocol versions
    can be specified.

    website_and_docs/content/documentation/grid/configuration/toml_options.en.md [137]

    -# Optional, enforce a specific protocol version in HttpClient when communicating with the endpoint service status (e.g. HTTP/1.1, HTTP/2)
+# Optional, enforce a specific protocol version in HttpClient when communicating with the endpoint service status (e.g. HTTP/1.1 or HTTP/2)
    Forward-compatibility
    Mention potential future protocol support in the documentation.

    Add a note about potential future support for newer HTTP protocols like HTTP/2 to keep the
    documentation forward-compatible.

    website_and_docs/content/documentation/grid/configuration/cli_options.ja.md [239]

    -| `--service-protocol-version` | string | `HTTP/1.1` | Optional, enforce a specific protocol version in HttpClient when communicating with the endpoint service status |
+| `--service-protocol-version` | string | `HTTP/1.1` | Optional, enforce a specific protocol version in HttpClient when communicating with the endpoint service status. Future protocols like HTTP/2 may also be supported. |
    Documentation
    Explain the rationale behind specifying protocol versions.

    It's beneficial to explain why enforcing a specific protocol version might be necessary,
    providing context for this configuration.

    website_and_docs/content/documentation/grid/configuration/toml_options.zh-cn.md [152]

    -# Optional, enforce a specific protocol version in HttpClient when communicating with the endpoint service status (e.g. HTTP/1.1, HTTP/2)
+# Optional, enforce a specific protocol version in HttpClient when communicating with the endpoint service status. This can be crucial for compatibility with older server configurations or to leverage performance enhancements in newer protocols like HTTP/2.
    Consistency
    Maintain consistency in protocol version documentation.

    Ensure consistency in protocol version options across all language versions of the
    documentation to prevent confusion.

    website_and_docs/content/documentation/grid/configuration/cli_options.pt-br.md [243]

    -| `--service-protocol-version` | string | `HTTP/1.1` | Optional, enforce a specific protocol version in HttpClient when communicating with the endpoint service status |
+| `--service-protocol-version` | string | `HTTP/1.1, HTTP/2` | Optional, enforce specific protocol versions in HttpClient when communicating with the endpoint service status |
    ✨ 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:
    /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

    [pr_code_suggestions]
some_config1=...
some_config2=...

    See the improve usage page for a comprehensive guide on using this tool.

    diemol
    diemol approved these changes Apr 23, 2024
    View reviewed changes
    Copy link
    Copy Markdown
    Member

    @diemol diemol 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, @VietND96!

    @diemol diemol merged commit 1f27efd into SeleniumHQ:trunk Apr 23, 2024
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    @diemol diemol diemol approved these changes

    Assignees

    No one assigned

    Labels

    documentation Improvements or additions to documentation enhancement New feature or request Review effort [1-5]: 2

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    2 participants

    @VietND96 @diemol