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

Include SE_CLEAR_CACHE and SE_CLEAR_METADATA in SM doc #1725

Merged
merged 1 commit into from
May 17, 2024
Merged

Conversation

bonigarcia
Copy link
Member

@bonigarcia bonigarcia commented May 17, 2024

User description

Description

This PR includes the use of the envs SE_CLEAR_CACHE and SE_CLEAR_METADATA in the SM page.

Motivation and Context

During the Dev Summit 2024, we realized these envs are not documented in the SM page.

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

  • This PR documents the environment variables SE_CLEAR_CACHE and SE_CLEAR_METADATA as equivalents to the command-line arguments --clear-cache and --clear-metadata in the Selenium Manager documentation.
  • Changes have been made across English, Japanese, Brazilian Portuguese, and Chinese versions of the documentation.

Changes walkthrough 📝

Relevant files
Documentation
selenium_manager.en.md
Document Environment Variables for Cache Management           

website_and_docs/content/documentation/selenium_manager.en.md

  • Added environment variable equivalents for command-line arguments
    --clear-cache and --clear-metadata.
  • +2/-2     
    selenium_manager.ja.md
    Document Environment Variables for Cache Management           

    website_and_docs/content/documentation/selenium_manager.ja.md

  • Added environment variable equivalents for command-line arguments
    --clear-cache and --clear-metadata.
  • +2/-2     
    selenium_manager.pt-br.md
    Document Environment Variables for Cache Management           

    website_and_docs/content/documentation/selenium_manager.pt-br.md

  • Added environment variable equivalents for command-line arguments
    --clear-cache and --clear-metadata.
  • +2/-2     
    selenium_manager.zh-cn.md
    Document Environment Variables for Cache Management           

    website_and_docs/content/documentation/selenium_manager.zh-cn.md

  • Added environment variable equivalents for command-line arguments
    --clear-cache and --clear-metadata.
  • +2/-2     

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

    @codiumai-pr-agent-pro codiumai-pr-agent-pro bot added the documentation Improvements or additions to documentation label May 17, 2024
    Copy link
    Contributor

    PR Description updated to latest commit (9dd3f16)

    Copy link
    Contributor

    PR Review 🔍

    ⏱️ Estimated effort to review [1-5]

    2, because the changes are straightforward and limited to documentation updates across multiple language versions. The modifications involve adding equivalent environment variable information to existing command-line arguments, which is not complex but requires careful verification across different languages.

    🧪 Relevant tests

    No

    ⚡ Possible issues

    No

    🔒 Security concerns

    No

    Copy link
    Contributor

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Enhancement
    Correct a typo in the text

    Correct the typo in the word "two" to "to" in the description of the additional arguments
    for handling the cache.

    website_and_docs/content/documentation/selenium_manager.en.md [160]

    -Selenium Manager includes two additional arguments two handle the cache, namely:
    +Selenium Manager includes two additional arguments to handle the cache, namely:
     
    Suggestion importance[1-10]: 7

    Why: The suggestion correctly identifies and fixes a typo in the documentation, which improves readability and professionalism. However, it's a minor text correction, not affecting functionality or security.

    7

    Copy link

    netlify bot commented May 17, 2024

    Deploy Preview for selenium-dev ready!

    Name Link
    🔨 Latest commit 9dd3f16
    🔍 Latest deploy log https://app.netlify.com/sites/selenium-dev/deploys/66469f2adde50a0008ff70e0
    😎 Deploy Preview https://deploy-preview-1725--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

    @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, @bonigarcia!

    @diemol diemol merged commit 9440b0a into trunk May 17, 2024
    6 checks passed
    @diemol diemol deleted the sm_cache_envs branch May 17, 2024 00:09
    selenium-ci added a commit that referenced this pull request May 17, 2024
    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]: 2
    Projects
    Status: Done
    Development

    Successfully merging this pull request may close these issues.

    None yet

    2 participants