From 4e92335e1a165558cfb68710aac3b11c51fb78c6 Mon Sep 17 00:00:00 2001 From: Ivan Ogasawara Date: Thu, 13 Feb 2025 03:33:43 +0000 Subject: [PATCH 1/3] pages: Improve os internship page --- mkdocs.yml | 4 +- pages/opportunities/os-internship/index.md | 169 ++++++++---------- .../templates/intern-proposal.md | 112 ------------ .../os-internship/templates/projects-ideas.md | 63 ------- 4 files changed, 76 insertions(+), 272 deletions(-) delete mode 100644 pages/opportunities/os-internship/templates/intern-proposal.md delete mode 100644 pages/opportunities/os-internship/templates/projects-ideas.md diff --git a/mkdocs.yml b/mkdocs.yml index f2417a4a..d93df42f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -38,8 +38,8 @@ nav: - index: "opportunities/os-internship/index.md" - Interns Guide: "opportunities/os-internship/guides/interns/index.md" - Mentors Guide: "opportunities/os-internship/guides/mentors/index.md" - - "TEMPLATE: Projects Ideas": "opportunities/os-internship/templates/projects-ideas.md" - - "TEMPLATE: Intern Project Proposal": "opportunities/os-internship/templates/intern-proposal.md" + - Projects Ideas Template: "opportunities/templates/projects-ideas/index.md" + - Candidates's Project Proposal Template: "opportunities/templates/candidate-proposal/index.md" - Google Summer of Code: - index: "opportunities/gsoc/index.md" - Project Ideas: "opportunities/gsoc/project-ideas/index.md" diff --git a/pages/opportunities/os-internship/index.md b/pages/opportunities/os-internship/index.md index 0e83656a..06b46e73 100644 --- a/pages/opportunities/os-internship/index.md +++ b/pages/opportunities/os-internship/index.md @@ -8,100 +8,79 @@ template: single-sidebar.html # Open Source Internship Program -Welcome to the Open Science Labs (OSL) Open Source Internship Program! At the -heart of our mission lies the commitment to foster innovation and growth within -the realm of open science and open source. This program is an embodiment of that -commitment, providing an inclusive, dynamic, and nurturing environment for -contributors of all backgrounds-whether you're a student stepping into the world -of open-source, or a professional looking to give back and refine your skills. - -This program is a partnership between OSL and -[The GRAPH Network](https://thegraphnetwork.org), who enhances our reach and -impact across the scientific community. - -With a structure inspired by the Google Summer of Code, our program offers some -unique features: - -- **Open Participation**: We welcome everyone from students to professionals, - embracing diversity in knowledge and experience. Prospective participants - should submit their relevant project ideas to designated OSL mentors or - supervisors through email or our social media platforms like Discord. -- **Flexible Commitment**: A minimum of 20 hours per week allows for impactful - work while accommodating your schedule. -- **Flexible Application Timeline**: Our Open Source Internship Program now - offers a rolling application process, allowing candidates to apply at any time - that fits their schedule. This flexibility ensures that everyone has the - opportunity to participate and gain valuable experience without the - constraints of fixed cycles. Whether you're ready to dive into a new project - now or planning for the future, you can submit your application when it suits +This document provides guidelines for both open-source project maintainers and +internship candidates at Open Science Labs (OSL). + +## Overview + +OSL is committed to fostering innovation and growth within the open science and +open source communities. This internship program embodies that commitment by +providing a dynamic and supportive environment for contributors at all +levels—from students just stepping into the world of open-source to +professionals looking to refine their skills. + +This program operates in partnership with +[The GRAPH Network](https://thegraphnetwork.org), enhancing our reach and impact +across the scientific community. + +## Program Structure + +Modeled after Google Summer of Code, our program offers the following key +features: + +- **Open Participation**: Open to everyone from students to professionals, we + embrace diversity in knowledge and experience. Applicants should submit their + project ideas directly to the mentors via email. +- **Flexible Commitment**: Participants are expected to contribute a minimum of + 20 hours per week, allowing for substantial contribution while accommodating + personal schedules. +- **Rolling Applications**: We accept applications on a rolling basis, providing + flexibility to accommodate participants' timing and availability. This ensures + opportunities are accessible year-round, allowing you to engage when it suits you best. -- **End-of-Cycle Presentations**: At the end of each cycle, participants are - encouraged to share their journey and project outcomes, enhancing their public - speaking and technical communication skills. -- **Non-Monetary Rewards**: While the internship does not offer financial +- **Final Presentation**: Participants will present their projects at the + program's conclusion, enhancing their public speaking and technical + communication skills. +- **Non-Monetary Rewards**: While the internship does not provide financial compensation, it offers invaluable experience, mentorship, networking - opportunities, and the satisfaction of contributing to open-source projects - that matter. - -In this program, contributors will not only gain practical experience by working -on real-world projects but also become an integral part of a community striving -for a collective goal—advancing open source and open science for a better -future. - -## Requirements - -### Contributor Candidate Requirements - -For those interested in taking advantage of the Open Science Labs -Internship/Apprenticeship Program, there are several key requirements that -ensure a productive and rewarding experience for both the contributor and the -program: - -- **English Proficiency**: Candidates must be able to effectively communicate in - English, as it is the primary language used for collaboration and - communication within the program. -- **Age Requirement**: All candidates must be at least 18 years old at the time - of applying to participate in the program. -- **Time Commitment**: Prospective interns are expected to dedicate a minimum of - 20 hours per week to the program throughout the cycle, which spans 3 months. -- **Duration of Commitment**: Candidates must be prepared to commit to the full - duration of the program cycle to ensure continuity and impact of their - contributions. -- **Nature of Opportunity**: It's important to note that this is a non-paid - opportunity, ideal for those looking to gain experience and grow their network - in the open science community. -- **Initial Contribution**: Before official acceptance, candidates should make a - small contribution to their project of interest. This allows mentors to assess - the candidate’s skills and commitment levels. - -We seek candidates who are passionate about open science and eager to make -significant contributions to the open-source community. If you meet these -requirements and are ready to engage with cutting-edge projects, we encourage -you to apply. - -### Requirements for Sub-Organizations - -To join the Open Science Labs Internship/Apprenticeship Program as a -sub-organization, the following criteria must be met: - -- **Open Source Licensing**: The project(s) must be released under a license - approved by the Open Source Initiative (OSI) or have a Software Package Data - Exchange (SPDX) identifier. Licenses not recognized by OSI will be subject to - review to ensure alignment with the program's objectives. -- **Issue Availability**: There should be an array of open issues available for - the duration of the program cycle, offering a variety of engagement - opportunities for contributors. -- **Mentorship**: Each project under the sub-organization must have at least one - mentor committed to guiding contributors. However, for a robust mentoring - experience, having at least two mentors per project is recommended. -- **Application Submission**: The application to join as a sub-organization must - be submitted by a core contributor or a maintainer of the project or - organization to ensure commitment and reliability. -- **Code of Conduct**: All projects looking to participate must adhere to a - publicly visible code of conduct to ensure a safe, inclusive, and respectful - environment for all contributors. - -By fulfilling these requirements, your sub-organization will contribute to a -productive and ethical collaboration space, supporting the growth of -contributors and the advancement of open-source projects through our -internship/apprenticeship program. + opportunities, and the satisfaction of contributing to significant open-source + projects. + +## For Intern Candidates + +### Requirements + +Prospective interns must meet the following criteria: + +- **English Proficiency**: Effective communication in English is required for + collaboration within the program. +- **Age Requirement**: Applicants must be at least 18 years old at the time of + application. +- **Time Commitment**: A minimum of 20 hours per week is required during the + 3-month internship period. +- **Nature of Opportunity**: This is an unpaid internship, ideal for gaining + experience and networking in the open science community. +- **Initial Contribution**: Candidates must make a preliminary contribution to + their chosen project, allowing mentors to evaluate their skills and + commitment. + +This program is perfect for those passionate about open science and eager to +contribute to our projects. If you meet these requirements and are ready to +engage with innovative projects, we encourage you to apply. + +For a full list of projects under the OSL umbrella, visit +[here](/projects/list/). To learn more, please contact the project maintainer +directly. + +## For Open-Source Project Contributors + +If you are a maintainer or core contributor of an open-source project, you can +submit your project for affiliation with OSL, making it eligible for our +Internship Program. + +For more information on affiliation, please visit +[Projects Affiliation](/projects/affiliation/). + +If your project is already affiliated with OSL, you can submit your project idea +proposal to `team@opensciencelabs.org`. Please use the template provided at +[Project Idea Template](/opportunities/templates/projects-ideas/). diff --git a/pages/opportunities/os-internship/templates/intern-proposal.md b/pages/opportunities/os-internship/templates/intern-proposal.md deleted file mode 100644 index c75865d2..00000000 --- a/pages/opportunities/os-internship/templates/intern-proposal.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -title: "TEMPLATE: Intern Project Proposal" -description: "TEMPLATE: Intern Project Proposal" -date: "2024-01-09" -authors: ["OSL Team"] -template: single-sidebar.html ---- - -``` -Instructions: - -* Remove HTML Comments: Please delete all content found within HTML - comment tags, denoted by (in the source code of this file). -* Replace Placeholders: Look for text enclosed in square brackets [ and ]. - Replace this placeholder text with relevant information. -* Remove Square Brackets: After replacing the placeholders, ensure to remove - the square brackets [ and ] themselves. -``` - -# [Project Proposal Name] - -## Candidate Info - -- **Name:** [Candidate's Name] -- **GitHub:** [Candidate's GitHub URL] -- **Email:** [Candidate's Email] -- **Twitter/X:** [Candidate's Twitter/X URL] -- **University Course:** [Current or Last University Course Name] -- **University:** [Current or Last University Name] -- **Time Zone:** [Candidate's Current Timezone] - -**Bio:** - -[Provide a one or two-paragraph bio of the candidate.] - -## Project Overview - -- **Project:** [Desired Project Name] -- **Project Idea/Plan:** [Desired Project Idea] -- **Expected Time (hours):** [Total Time Dedicated Over 3 Months] - -### Abstract - -[Provide a brief abstract of the project idea/plan.] - -### Mentors - -[List the mentors for this internship project.] - -### Implementation Plan - -[Describe the tasks according to the project plan/idea.] - -### Benefits to the Community - -[Explain how the project will benefit the community or users.] - -## Planned Workflow - -[Detail your planned workflow, including the project management methodology, -frequency and focus of mentor meetings, progress tracking, and task management -strategies.] - -## Deliverables - -[List all expected deliverables, such as new features, documentation updates, -tutorials, and blog posts. Consider writing a blog post for each major feature -or bug fix.] - -## Timeline - -[Provide a detailed timeline of the internship, including key dates and tasks. -This should include Community Bonding Period activities, task periods, blog post -submission dates, and Midterm and Final evaluation schedules.] - -| Dates | Tasks | -| :---- | :---- | -| | | - -## Previous Contributions to the Project - -[Summarize your contributions to the project, including the number of merged -PRs, resolved issues, or types of contributions.] - -### Pull Requests - -[List all contributed PRs with titles, numbers, links, and their status.] - -| Pull Request Title/Number | Status | -| :------------------------ | :----- | -| | | - -### Issues - -[List all resolved issues with titles, numbers, links, and their status.] - -| Issue Title/Number | Status | -| :----------------- | :----- | -| | | - -## Why This Project? - -[Explain your motivation for choosing this project.] - -## Availability - -[Confirm your availability during the internship, including weekly hours, other -commitments, and a plan for catching up if behind schedule.] - -## Post-OSL Internship Program - -[Outline any plans for continuing contributions to the project post-internship.] diff --git a/pages/opportunities/os-internship/templates/projects-ideas.md b/pages/opportunities/os-internship/templates/projects-ideas.md deleted file mode 100644 index f40cb22c..00000000 --- a/pages/opportunities/os-internship/templates/projects-ideas.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "TEMPLATE: Projects Ideas" -description: "TEMPLATE: Projects Ideas" -date: "2023-11-01" -authors: ["OSL Team"] -template: single-sidebar.html ---- - -``` -Instructions: - -* Remove HTML Comments: Please delete all content found within HTML - comment tags, denoted by (in the source code of this file). -* Replace Placeholders: Look for text enclosed in square brackets [ and ]. - Replace this placeholder text with relevant information. -* Remove Square Brackets: After replacing the placeholders, ensure to remove - the square brackets [ and ] themselves. -* Add Additional Content: If you have more Project Ideas to include, please - add them at the end of the document. Follow the provided template format for - consistency. -``` - -## Project Idea 1: [Project Idea 1 Title] - -### Abstract - -[Short summary or abstract of Project Idea 1] - -### License - -[Project License Name]: [Link to the project license] - -### Code of Conduct - -[Link to the Code of Conduct] - -### Current State - -[Current status or progress of Project Idea 1] - -### Tasks - -[List of specific tasks for Project Idea 1] - -### Expected Outcomes - -[Desired results or achievements for Project Idea 1] - -### Details - -- Prerequisites: - - [List prerequisites here] -- Expected Time: [#] hours (note: minimum 350 hours) -- Potential Mentor(s): [Mentor 1, Mentor 2, ...] - - -### References - -[Include any relevant links or resources for this project idea] - ---- - - From e0c083429581f2b5adb5c77c9db89485208f03de Mon Sep 17 00:00:00 2001 From: Ivan Ogasawara Date: Thu, 13 Feb 2025 03:35:58 +0000 Subject: [PATCH 2/3] pages: Improve os internship page --- .../templates/candidate-proposal/index.md | 114 ++++++++++++++++++ .../templates/projects-ideas/index.md | 65 ++++++++++ 2 files changed, 179 insertions(+) create mode 100644 pages/opportunities/templates/candidate-proposal/index.md create mode 100644 pages/opportunities/templates/projects-ideas/index.md diff --git a/pages/opportunities/templates/candidate-proposal/index.md b/pages/opportunities/templates/candidate-proposal/index.md new file mode 100644 index 00000000..17da8695 --- /dev/null +++ b/pages/opportunities/templates/candidate-proposal/index.md @@ -0,0 +1,114 @@ +--- +title: "Intern Project Proposal Template" +description: "Intern Project Proposal Template" +date: "2024-01-09" +authors: ["OSL Team"] +template: single-sidebar.html +--- + +``` +Instructions: + +* Remove HTML Comments: Please delete all content found within HTML + comment tags, denoted by (in the source code of this file). +* Replace Placeholders: Look for text enclosed in square brackets [ and ]. + Replace this placeholder text with relevant information. +* Remove Square Brackets: After replacing the placeholders, ensure to remove + the square brackets [ and ] themselves. +``` + +``` +# [Project Proposal Name] + +## Candidate Info + +- **Name:** [Candidate's Name] +- **GitHub:** [Candidate's GitHub URL] +- **Email:** [Candidate's Email] +- **Twitter/X:** [Candidate's Twitter/X URL] +- **University Course:** [Current or Last University Course Name] +- **University:** [Current or Last University Name] +- **Time Zone:** [Candidate's Current Timezone] + +**Bio:** + +[Provide a one or two-paragraph bio of the candidate.] + +## Project Overview + +- **Project:** [Desired Project Name] +- **Project Idea/Plan:** [Desired Project Idea] +- **Expected Time (hours):** [Total Time Dedicated Over 3 Months] + +### Abstract + +[Provide a brief abstract of the project idea/plan.] + +### Mentors + +[List the mentors for this internship project.] + +### Implementation Plan + +[Describe the tasks according to the project plan/idea.] + +### Benefits to the Community + +[Explain how the project will benefit the community or users.] + +## Planned Workflow + +[Detail your planned workflow, including the project management methodology, +frequency and focus of mentor meetings, progress tracking, and task management +strategies.] + +## Deliverables + +[List all expected deliverables, such as new features, documentation updates, +tutorials, and blog posts. Consider writing a blog post for each major feature +or bug fix.] + +## Timeline + +[Provide a detailed timeline of the internship, including key dates and tasks. +This should include Community Bonding Period activities, task periods, blog post +submission dates, and Midterm and Final evaluation schedules.] + +| Dates | Tasks | +| :---- | :---- | +| | | + +## Previous Contributions to the Project + +[Summarize your contributions to the project, including the number of merged +PRs, resolved issues, or types of contributions.] + +### Pull Requests + +[List all contributed PRs with titles, numbers, links, and their status.] + +| Pull Request Title/Number | Status | +| :------------------------ | :----- | +| | | + +### Issues + +[List all resolved issues with titles, numbers, links, and their status.] + +| Issue Title/Number | Status | +| :----------------- | :----- | +| | | + +## Why This Project? + +[Explain your motivation for choosing this project.] + +## Availability + +[Confirm your availability during the internship, including weekly hours, other +commitments, and a plan for catching up if behind schedule.] + +## Post-OSL Internship Program + +[Outline any plans for continuing contributions to the project post-internship.] +``` diff --git a/pages/opportunities/templates/projects-ideas/index.md b/pages/opportunities/templates/projects-ideas/index.md new file mode 100644 index 00000000..0de5e10a --- /dev/null +++ b/pages/opportunities/templates/projects-ideas/index.md @@ -0,0 +1,65 @@ +--- +title: "Projects Ideas Template" +description: "Projects Ideas Template" +date: "2023-11-01" +authors: ["OSL Team"] +template: single-sidebar.html +--- + +``` +Instructions: + +* Remove HTML Comments: Please delete all content found within HTML + comment tags, denoted by (in the source code of this file). +* Replace Placeholders: Look for text enclosed in square brackets [ and ]. + Replace this placeholder text with relevant information. +* Remove Square Brackets: After replacing the placeholders, ensure to remove + the square brackets [ and ] themselves. +* Add Additional Content: If you have more Project Ideas to include, please + add them at the end of the document. Follow the provided template format for + consistency. +``` + +``` +## Project Idea 1: [Project Idea 1 Title] + +### Abstract + +[Short summary or abstract of Project Idea 1] + +### License + +[Project License Name]: [Link to the project license] + +### Code of Conduct + +[Link to the Code of Conduct] + +### Current State + +[Current status or progress of Project Idea 1] + +### Tasks + +[List of specific tasks for Project Idea 1] + +### Expected Outcomes + +[Desired results or achievements for Project Idea 1] + +### Details + +- Prerequisites: + - [List prerequisites here] +- Expected Time: [#] hours (note: minimum 350 hours) +- Potential Mentor(s): [Mentor 1, Mentor 2, ...] + + +### References + +[Include any relevant links or resources for this project idea] + +--- + + +``` From 73f74c45b3d4137f3a427c033819e4ebc033de9a Mon Sep 17 00:00:00 2001 From: Ivan Ogasawara Date: Thu, 13 Feb 2025 03:49:00 +0000 Subject: [PATCH 3/3] fix small issues --- pages/opportunities/templates/candidate-proposal/index.md | 2 +- pages/opportunities/templates/projects-ideas/index.md | 2 +- theme/projects.html | 5 +++-- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/pages/opportunities/templates/candidate-proposal/index.md b/pages/opportunities/templates/candidate-proposal/index.md index 17da8695..0ae3fff3 100644 --- a/pages/opportunities/templates/candidate-proposal/index.md +++ b/pages/opportunities/templates/candidate-proposal/index.md @@ -17,7 +17,7 @@ Instructions: the square brackets [ and ] themselves. ``` -``` +```md # [Project Proposal Name] ## Candidate Info diff --git a/pages/opportunities/templates/projects-ideas/index.md b/pages/opportunities/templates/projects-ideas/index.md index 0de5e10a..eeb4281b 100644 --- a/pages/opportunities/templates/projects-ideas/index.md +++ b/pages/opportunities/templates/projects-ideas/index.md @@ -20,7 +20,7 @@ Instructions: consistency. ``` -``` +```md ## Project Idea 1: [Project Idea 1 Title] ### Abstract diff --git a/theme/projects.html b/theme/projects.html index ef742f34..949c130f 100644 --- a/theme/projects.html +++ b/theme/projects.html @@ -9,6 +9,7 @@ {% endblock header_extra%} {% set colors=["", "bg-light"] %} +{% set text_colors=["", "text-secondary"] %} {% block content %}
@@ -43,11 +44,11 @@

{{ project.name }}

-

+

Maintainer: {{ project.maintainer_name }} <{{ project.maintainer_email }}>

-

{{ project.description }}

+

{{ project.description }}

{% endfor %}