Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Create new development sponsors level #1713

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

Merged
diemol merged 1 commit into trunk from development_sponsors
May 9, 2024
Merged

Create new development sponsors level #1713

diemol merged 1 commit into trunk from development_sponsors
May 9, 2024

Conversation

@AutomatedTester
Copy link
Member

@AutomatedTester AutomatedTester commented May 9, 2024 •
edited by qodo-merge-pro 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.

Add a new level for sponsors

Description

Implementing agreed new level for sponsors by the PLC

Motivation and Context

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

enhancement

Description

  • Added a new 'development-level-sponsors' section across various parts of the website including home, footer, and sponsors list page.
  • Created a new HTML partial for rendering development level sponsors.
  • Updated the sponsors data file to include new development level sponsors.

Changes walkthrough 📝

Relevant files
Enhancement
home.html
Integrate Development Level Sponsors into Home Page

website_and_docs/layouts/home.html

  • Added a new partial for 'development-level-sponsors' to the home page
    layout.
    • +1/-0
    development-level-sponsors.html
    Create New Partial for Development Level Sponsors

    website_and_docs/layouts/partials/development-level-sponsors.html

  • Created a new partial for displaying development level sponsors.
  • Includes conditional rendering and a loop over sponsor data.
    • +14/-0
    footer.html
    Add Development Sponsors to Footer

    website_and_docs/layouts/partials/footer.html

  • Included the new 'development-level-sponsors' partial in the footer.
    • +1/-0
    list.html
    Update Sponsors List Page with Development Level

    website_and_docs/layouts/sponsors/list.html

  • Added 'development-level-sponsors' partial to the sponsors list page.
    • +5/-3
    Configuration changes
    sponsors.yml
    Update Sponsor Data with New Development Level

    website_and_docs/data/sponsors.yml

  • Added a new 'development' section with sponsor data.
  • Updated existing sponsor data structure.
    • +11/-7

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

    @qodo-merge-pro qodo-merge-pro bot added the enhancement New feature or request label May 9, 2024
    Copy link
    Contributor

    qodo-merge-pro bot commented May 9, 2024

    PR Description updated to latest commit (7538c11)

    Copy link
    Contributor

    qodo-merge-pro bot commented May 9, 2024

    PR Review 🔍

    ⏱️ Estimated effort to review [1-5]

    2, because the changes are mostly straightforward HTML and YAML updates, involving the addition of a new sponsorship level and its corresponding data. The changes are localized and do not involve complex logic or algorithms, making the review process relatively simple.

    🧪 Relevant tests

    No

    ⚡ Possible issues

    Consistency Issue: Ensure that the new 'development-level-sponsors.html' partial is correctly integrated across all necessary pages without duplicating or overriding existing sponsor levels.

    Data Integrity: Verify that the sponsorship data in 'sponsors.yml' correctly reflects the new sponsorship level and that the URLs and logos are accurate and lead to the intended destinations.

    🔒 Security concerns

    No

    Copy link

    netlify bot commented May 9, 2024

    ✅ Deploy Preview for selenium-dev ready!

    Name Link
    🔨 Latest commit 7538c11
    🔍 Latest deploy log https://app.netlify.com/sites/selenium-dev/deploys/663cb2f49c99720008715794
    😎 Deploy Preview https://deploy-preview-1713--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
    Contributor

    qodo-merge-pro bot commented May 9, 2024

    PR Code Suggestions ✨

    CategorySuggestions
    Bug
    Correct the conditional check to display the development sponsors based on their specific enable flag.

    The condition to display the "Development Level Sponsors" section checks if Selenium
    sponsors are enabled, which might be incorrect. It should check if Development sponsors
    are enabled instead.

    website_and_docs/layouts/partials/development-level-sponsors.html [1] 

    -{{ if .Data.sponsors.selenium.enable }}
+{{ if .Data.sponsors.development.enable }}
    Enhancement
    Rename CSS classes to reflect the correct sponsorship level.

    The class name 'selenium' used in the header and image elements might be misleading as
    this is for development level sponsors. Consider renaming it to a more appropriate class
    name like 'development'.

    website_and_docs/layouts/partials/development-level-sponsors.html [3-9] 

    -<h2 class="selenium text-center">Development Level Sponsors</h2>
-<img class="w-100 shadow-1-strong rounded selenium-backer-logo" src="{{ .logo }}" alt="{{ .name }}" />
+<h2 class="development text-center">Development Level Sponsors</h2>
+<img class="w-100 shadow-1-strong rounded development-backer-logo" src="{{ .logo }}" alt="{{ .name }}" />
    Best practice
    Standardize data passing to partials for consistency.

    Ensure consistent data passing to partials by using the same method. Here, use dict for
    all partials to maintain uniformity and readability.

    website_and_docs/layouts/home.html [5-8] 

     {{ partial "development-level-sponsors.html" (dict "Data" $.Site.Data) }}
 {{ partial "selenium-level-sponsors.html" (dict "Data" $.Site.Data) }}
 {{ partial "platinum-level-sponsors.html" (dict "Data" $.Site.Data) }}
-{{ partial "news-feed.html" (dict "regular_pages" $.Site.RegularPages) }}
+{{ partial "news-feed.html" (dict "Data" $.Site.Data "regular_pages" $.Site.RegularPages) }}
    Possible issue
    Verify the addition of content in the sponsors list for potential layout issues.

    The addition of the .Content display in the sponsors list might introduce duplicate
    content issues or affect the layout. Consider verifying or testing this change to ensure
    it integrates well without disrupting the existing design.

    website_and_docs/layouts/sponsors/list.html [5] 

    +<!-- Ensure this addition does not disrupt layout -->
 {{ .Content }}
    Performance
    Conditionally load the development sponsors partial in the footer to optimize page loading.

    The addition of the "development-level-sponsors.html" partial in the footer should be
    conditional based on the page type or section, similar to other partials, to avoid
    unnecessary loading on irrelevant pages.

    website_and_docs/layouts/partials/footer.html [3] 

    -{{ partial "development-level-sponsors.html" (dict "Data" $.Site.Data) }}
+{{ if and (ne .Kind "home") (ne .Section "sponsors") }}
+ {{ partial "development-level-sponsors.html" (dict "Data" $.Site.Data) }}
+{{ end }}

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

    @diemol diemol merged commit ce0ed15 into trunk May 9, 2024
    @diemol diemol deleted the development_sponsors branch May 9, 2024 11:29
    selenium-ci added a commit that referenced this pull request May 9, 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

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    AltStyle によって変換されたページ (->オリジナル) /