update mentorship-programs.md under handbook #2215
Conversation
Signed-off-by: Nitish C <86357181+Nitish-bot@users.noreply.github.com>
|
Yay, your first pull request! 👍 A contributor will be by to give feedback soon. In the meantime, please review the Newcomers' Guide and sure to join the community Slack. |
✅ Deploy Preview for mesheryio-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @Nitish-bot, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
Hello! Gemini here, providing a summary of this pull request. This PR introduces a new page to the handbook specifically dedicated to outlining the various mentorship programs that Layer5/Meshery participates in. The goal is to consolidate information about programs like MeshMates, GSoD, GSoC, CNCF, LFX, and MLH into a single, easily accessible location within the handbook, addressing issue #2190. The page includes descriptions, links, and associated icons for each program, presented with custom styling for readability and visual appeal.
Highlights
- New Handbook Page: Adds a completely new page at
/community/handbook/mentorship-programsto document the organization's participation in various mentorship programs. - Mentorship Program Listing: Includes a structured list of mentorship programs (MeshMates, GSoD, GSoC, CNCF, LFX, MLH) with descriptions, links, and icons, rendered dynamically using Jekyll/Liquid templating.
- Custom Styling: Incorporates inline CSS to style the program list, providing a responsive layout that adjusts for different screen sizes and presents program details alongside their icons.
Changelog
- collections/_handbook/mentorship-programs.md
- Added new file for the mentorship programs handbook page.
- Defined Jekyll front matter including layout, title, permalink, and description.
- Included a YAML list of mentorship programs with details like name, description, link, icon path, and image position.
- Implemented HTML structure and Liquid templating to iterate over the program list and display each entry.
- Added inline CSS styles to format the program list, including responsive design considerations.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces a new handbook page for Mentorship Programs, which is a valuable addition. The page structure, content, and initial styling are well-implemented. I appreciate the notes in the PR description regarding potential content updates (missing/outdated programs) and icon improvements – these show good foresight.
My review focuses on a few areas to enhance HTML semantics, content accuracy, and CSS maintainability. Addressing these points will help ensure the page is clear, accessible, and easy to maintain in the long run.
Summary of Findings
- Outdated Program Link: The Google Season of Docs link points to 2021, which may be outdated or confusing for users. This needs clarification or update.
- Semantic HTML for Links as Buttons: The 'Learn More' navigation elements are structured as
<a><button></button></a>. It's recommended to use<a class="button-style">for better semantics and simpler DOM. - CSS Organization: Page-specific CSS is embedded directly in the markdown. Consider moving to an external stylesheet for better maintainability, following project conventions.
- Icon Styling and Visibility: The use of
drop-shadowon potentially white icons might not be ideal for all themes/backgrounds. The author's suggestion to use colored icons is supported.
Merge Readiness
The pull request is a good start for the new mentorship programs page. However, there are a few medium severity issues related to content accuracy, HTML semantics, and CSS practices that should be addressed to improve the page's quality and maintainability. I recommend making these changes before merging. As I am an AI assistant, I am not authorized to approve pull requests; please ensure further review and approval from the maintainers.
Signed-off-by: Nitish C <86357181+Nitish-bot@users.noreply.github.com>
|
|
Signed-off-by: Nitish C <86357181+Nitish-bot@users.noreply.github.com>
Signed-off-by: Nitish C <86357181+Nitish-bot@users.noreply.github.com>
Signed-off-by: Nitish C <86357181+Nitish-bot@users.noreply.github.com>
|
@Nitish-bot this looks good, overall. You've also updated the referenced icons with their updated paths 👍🏼 |
|
A small change, or improvement that you could make is to reduce the gap between 2 programs here, in mobile view |
|
LGTM 👍🏼 |
|
@Nitish-bot what's the final decision on the programs section? are we keeping them as is? |
|
@M-DEV-1 what do you suggest? I didn't hear back from you on slack, I was about to ping you for the same. |
Signed-off-by: Nitish C <86357181+Nitish-bot@users.noreply.github.com>
Signed-off-by: Nitish C <86357181+Nitish-bot@users.noreply.github.com>
|
@Nitish-bot LGTM 👍🏼 |
Description
Added the
/handbook/mentorship-programspageThis PR fixes #2190
Notes for Reviewers
edit: GSOD has officially been discontinued so I don't think we should keep it in any case
Notes for self:
Signed commits