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

Added Steps to Create Custom Selenium Manager to Documentation #1990

Merged
merged 4 commits into from
Nov 7, 2024

Conversation

shbenzer
Copy link
Contributor

@shbenzer shbenzer commented Oct 12, 2024

Added steps to create a custom local Selenium Manager to the documentation. This PR covers Titus Fortner's Issue #1492 by utilizing Titus Fortner's recommended steps

Description

Updated Selenium_manager.mds in all translations

Motivation and Context

Makes documentation more comprehensive

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.

Copy link

netlify bot commented Oct 12, 2024

👷 Deploy request for selenium-dev pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 44c2823

Copy link
Contributor

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Score
Security
Emphasize the importance of keeping the custom-built Selenium Manager updated

Add a note about the importance of keeping the custom-built Selenium Manager
up-to-date with the latest security patches and bug fixes from the official
repository.

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

 7. Selenium will now use the built Selenium Manager to locate the manually downloaded driver on PATH
+8. Important: Regularly update your custom Selenium Manager by pulling the latest changes from the official repository and rebuilding to ensure you have the latest security patches and bug fixes.
  • Apply this suggestion
Suggestion importance[1-10]: 9

Why: The suggestion addresses a critical security aspect by advising users to keep their custom-built Selenium Manager updated with the latest patches, which is essential for maintaining security and functionality.

9
Enhancement
Use an absolute path for the environment variable to ensure compatibility across different systems

The environment variable setting uses a relative path, which may not work across
different systems. Consider using an absolute path or providing instructions on how
to determine the correct path based on the user's system.

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

-5. Set the following environment variable for the driver path `SE_MANAGER_PATH=~/selenium/rust/target/release/selenium-manager`
+5. Set the following environment variable for the driver path:
+   ```
+   export SE_MANAGER_PATH=/path/to/your/selenium/rust/target/release/selenium-manager
+   ```
+   Replace `/path/to/your/` with the actual path on your system where you cloned the Selenium repository.
  • Apply this suggestion
Suggestion importance[1-10]: 8

Why: This suggestion improves the robustness of the instructions by recommending an absolute path, which is crucial for ensuring the environment variable works across different systems, enhancing the clarity and reliability of the setup process.

8
Best practice
Explain the implications of using '--depth 1' when cloning the repository

Consider adding a note about potential security implications of cloning with --depth
1. While it speeds up the process, it may miss important security updates. Suggest
users to perform a full clone if they intend to contribute or need the full history.

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

-2. clone Selenium onto your local machine `git clone https://github.com/SeleniumHQ/selenium.git --depth 1`
+2. Clone Selenium onto your local machine:
+   ```
+   git clone https://github.com/SeleniumHQ/selenium.git --depth 1
+   ```
+   Note: Using `--depth 1` speeds up the clone but may miss important updates. For contribution or if you need the full history, omit this flag.
  • Apply this suggestion
Suggestion importance[1-10]: 7

Why: The suggestion highlights a potential security concern with using --depth 1 during cloning, which is a valid point for users who may need the full history for security updates or contributions. It adds valuable context to the documentation.

7

💡 Need additional feedback ? start a PR chat

Copy link

@A1exKH A1exKH left a comment

Choose a reason for hiding this comment

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

LGTM.

Copy link

@A1exKH A1exKH left a comment

Choose a reason for hiding this comment

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

LGTM.

@VietND96 VietND96 merged commit b9f2010 into SeleniumHQ:trunk Nov 7, 2024
3 checks passed
selenium-ci added a commit that referenced this pull request Nov 7, 2024
[deploy site]
Added Steps to Create Custom Selenium Manager b9f2010
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants