From 0f8fb3dc964b49c43262db27bfa0368dd8904aa0 Mon Sep 17 00:00:00 2001 From: Ivan Ogasawara Date: Mon, 13 Jan 2025 17:40:50 -0400 Subject: [PATCH] gsoc: add info about gsoc --- mkdocs.yml | 4 +- .../gsoc/guides/contributor/index.md | 23 ++- pages/opportunities/gsoc/index.md | 141 ++---------------- .../opportunities/gsoc/project-ideas/index.md | 118 +++++++++++++++ .../gsoc/templates/contributor-proposal.md | 90 ++++++----- .../gsoc/templates/project-ideas.md | 81 ++++++++++ theme/css/styles.css | 10 +- 7 files changed, 294 insertions(+), 173 deletions(-) create mode 100644 pages/opportunities/gsoc/project-ideas/index.md create mode 100644 pages/opportunities/gsoc/templates/project-ideas.md diff --git a/mkdocs.yml b/mkdocs.yml index d3086719e..4850034ec 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -42,8 +42,10 @@ nav: - "TEMPLATE: Intern Project Proposal": "opportunities/os-internship/templates/intern-proposal.md" - GSoC: - index: "opportunities/gsoc/index.md" + - Project Ideas: "opportunities/gsoc/project-ideas/index.md" - Contributor Guide: "opportunities/gsoc/guides/contributor/index.md" - - "TEMPLATE: Contributor Project Proposal": "opportunities/gsoc/templates/contributor-proposal.md" + - Project Idea Template: "opportunities/gsoc/templates/project-ideas.md" + - Contributor Project Proposal Template: "opportunities/gsoc/templates/contributor-proposal.md" - Partnership: - index: "partnership/index.md" - Partners: "partnership/partners/index.md" diff --git a/pages/opportunities/gsoc/guides/contributor/index.md b/pages/opportunities/gsoc/guides/contributor/index.md index 595cb9dd5..988ff8506 100644 --- a/pages/opportunities/gsoc/guides/contributor/index.md +++ b/pages/opportunities/gsoc/guides/contributor/index.md @@ -12,11 +12,13 @@ This comprehensive document is your gateway to engaging with a network of professionals and peers dedicated to the advancement of open science and open source. Whether you're considering applying to GSoC with Open Science Labs or if you've already been accepted, this guide is designed to facilitate a smooth -transition into our collaborative environment. You'll find detailed instructions -on how to apply, connect with sub-organizations/projects, and make the most of -your GSoC period once you're on board. It's a chance to contribute to a global -movement and develop skills that will serve you throughout your career. Let's -embark on this exciting journey together. +transition into our collaborative environment. + +You'll find detailed instructions on how to apply, connect with +sub-organizations/projects, and make the most of your GSoC period once you're on +board. It's a chance to contribute to a global movement and develop skills that +will serve you throughout your career. Let's embark on this exciting journey +together. ## Part I: Contributor Candidates @@ -88,3 +90,14 @@ open to code reviews and feedback, as they are learning opportunities. By following these guidelines, both candidates and approved contributors can maximize their growth, contributions, and overall experience within the GSoC with Open Science Labs. + +## Resources for writing the proposal + +Applicants should consult the +[GSoC Student Guide](https://google.github.io/gsocguides/student/) for more +details on how to apply and tips on crafting their proposals. Additional +recommendations can be found +[here](https://developers.google.com/open-source/gsoc/help/student-advice). + +For further guidance, our suggested proposal template offers valuable insights +and can be accessed [here](/opportunities/gsoc/templates/contributor-proposal). diff --git a/pages/opportunities/gsoc/index.md b/pages/opportunities/gsoc/index.md index 4255abb00..3e5682edb 100644 --- a/pages/opportunities/gsoc/index.md +++ b/pages/opportunities/gsoc/index.md @@ -6,137 +6,28 @@ authors: ["OSL Team"] template: single-sidebar.html --- -# Google Summer of Code (GSoC) with Open Science Labs, under NumFOCUS umbrella +# Google Summer of Code (GSoC) with Open Science Labs -## Google Summer of Code (GSoC) +Google Summer of Code is a global program focused on bringing students and +newcomer open-source developers into open-source software development. -Google Summer of Code is a global program focused on bringing more student -developers into open source software development. GSoC invites students to work -with an open source organization on a 3-month programming project during their -break from school. +For more detailed and complete information about the GSoC, please check its +[official guide](https://developers.google.com/open-source/gsoc/resources/guide) -## Open Science Labs' Participation in GSoC under NumFOCUS umbrella +### Contributor Guide -Open Science Labs is excited to announce that we've been accepted under -[NumFOCUS](https://github.com/numfocus/gsoc) umbrella as a participating -organization in GSoC 2024! Please, check out our -[list of projects](https://github.com/OpenScienceLabs/gsoc/blob/main/project-ideas/gsoc2024.md) -for more details. +Candidate contributors can find important information about GSoC in our +[Contributor Guide](/opportunities/gsoc/guides/contributor) section. -## Contributor Guide +### Project Ideas for GSoC -Candidates and contributors can find important information about GSoC in the -[Contributor Guide](/opportunities/gsoc/guides/contributor). +For more information about the Project Ideas, check the section +[Project Ideas](/opportunities/gsoc/project-ideas) -## Our Project Ideas for GSoC +### History -We have carefully curated a list of project ideas that not only align with our -vision at OSL but also offer challenging and rewarding experiences for student -developers. These projects span a range of topics and technologies, ensuring -there's something to engage every interested student. We believe these projects -offer an excellent opportunity for students to contribute to significant open -source initiatives while enhancing their skills and knowledge under the guidance -of experienced mentors. +Open Science Labs has participated in the GSoC 2024 and 2023 under +[NumFOCUS](https://github.com/numfocus/gsoc) umbrella. -This year, we are participating in GSoC with the following project ideas: -. - - +The list of OSL Project Ideas that participated in GSoC 2024 can be checked +[here](https://github.com/OpenScienceLabs/gsoc/blob/main/project-ideas/gsoc2024.md). diff --git a/pages/opportunities/gsoc/project-ideas/index.md b/pages/opportunities/gsoc/project-ideas/index.md new file mode 100644 index 000000000..21baef368 --- /dev/null +++ b/pages/opportunities/gsoc/project-ideas/index.md @@ -0,0 +1,118 @@ +--- +title: "TEMPLATE: GSoC Project Idea" +description: "TEMPLATE: GSoC Project Idea" +date: "2025-01-13" +authors: ["OSL Team"] +template: single-sidebar.html +--- + +# OSL Project Ideas for GSoC 2025 + +Welcome to the Open Science Labs (OSL) project ideas page for Google Summer of +Code 2025. As an umbrella organization, OSL hosts links to the ideas pages of +each member organization. You can explore these projects here. + +At OSL, we've assembled a selection of project ideas that not only embody our +mission but also provide enriching experiences for student and newcomers +open-source developpers. These projects cover a variety of topics and +technologies, catering to diverse interests. Below, we've outlined some +potential project ideas we're considering for GSoC. We believe these projects +provide students with a valuable chance to engage with open-source efforts and +develop their skills under the mentorship of seasoned professionals. + +This page details the sub-organizations available for GSoC 2025 participants. +Applicants are welcome to reach out to us on our +[Discord](https://opensciencelabs.org/discord) or directly contact the +sub-oganization/project mentors. + +## Sub-Organizations + +_Note: Each organization includes a designated list of mentors. Please get in +touch with them directly if you have any inquiries._ + +### ArtBox + +- **Description**: ArtBox is a tool set for handling multimedia files with a + bunch of useful functions. +- **Project WEB Page**: +- **Project Ideas**: + [link]() + +### ArxLang/ASTx + +- **Description**: ASTx is an agnostic expression structure for AST. It is + agnostic because it is not specific to any language, neither to the ArxLang + project, although its main focus is to provide all needed feature for ArxLang. +- **Project WEB Page**: +- **Project Ideas**: + [link]() + +### Envers + +- **Description**: Envers is a command-line tool (CLI) designed to manage and + version environment variables for different deployment stages such as staging, + development, and production. It provides a secure and organized way to handle + environment-specific configurations. +- **Project WEB Page**: +- **Project Ideas**: + [link]() + +### fqlearn + +- **Description**: This Project aims to facilitate the teaching of unit + operations and thermodynamics. +- **Project WEB Page**: +- **Project Ideas**: + [link]() + +### Makim + +- **Description**: Makim is based on make and focus on improve the way to define + targets and dependencies. Instead of using the Makefile format, it uses yaml + format. +- **Project WEB Page**: +- **Project Ideas**: + [link]() + +### noWorkflow + +- **Description**: The noWorkflow project aims at allowing scientists to benefit + from provenance data analysis even when they don't use a workflow system. It + transparently collects provenance from Python scripts and notebooks and + provide tools to support the analysis and management of the provenance. +- **Project WEB Page**: +- **Project Ideas**: + [link](https://gist.github.com/JoaoFelipe/ce4cb232deb2c71d4f39afc5cbeefe2b) + +### OSL Web Page + +- **Description**: OpenScienceLabs web page, is a project that serves as a way + to present OSL to the world through a web page. +- **Project WEB Page**: +- **Project Ideas**: + [link]() + +### PyDataStructs + +- **Description**: PyDataStructs project aims to be a Python package for various + data structures and algorithms (including their parallel implementations). +- **Project WEB Page**: +- **Project Ideas**: + [link](https://github.com/codezonediitj/pydatastructs/wiki/Google-Summer-of-Code-Project-Ideas) + +### SciCookie + +- **Description**: SciCookie is a template developed by + that creates projects from project templates. +- **Project WEB Page**: +- **Project Ideas**: + [link]() + +### Sugar + +- **Description**: Sugar aims to organize your stack of containers, gathering + some useful scripts and keeping this information centralized in a + configuration file. So the command line would be very simple. +- **Project WEB Page**: +- **Project Ideas**: + [link]() diff --git a/pages/opportunities/gsoc/templates/contributor-proposal.md b/pages/opportunities/gsoc/templates/contributor-proposal.md index 7bee4ea5d..4dd320096 100644 --- a/pages/opportunities/gsoc/templates/contributor-proposal.md +++ b/pages/opportunities/gsoc/templates/contributor-proposal.md @@ -6,69 +6,84 @@ 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] +# GSoC Contributor Project Proposal + + + +```md +# {{ 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] +- **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.] +{{ 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] +- **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.] +{{ Provide a brief abstract of the project idea/plan. }} ### Mentors -[List the mentors for this project proposal.] +{{ List the mentors for this project proposal. }} ### Technical Details -[Detail each task, providing technical specifics, relevant reference links, and +{{ Detail each task, providing technical specifics, relevant reference links, and preliminary solution ideas. Include findings from any preliminary research undertaken to address the issue, along with links to the specific segments of -code slated for modification or improvement. ] +code slated for modification or improvement. }} ### Benefits to the Community -[Explain how the project will benefit the community or users.] +{{ Explain how the project will benefit the community or users. }} ## Deliverables and Timeline ## Timeline -[Outline a comprehensive timeline for this project, specifying crucial +{{ Outline a comprehensive timeline for this project, specifying crucial milestones, deliverables, and tasks. Incorporate the Community Bonding Period, development of new features, resolution of bugs, enhancements to documentation, creation of tutorials, and preparation of blog posts. Break down each task to ensure clarity. It is mandatory for collaborators to write regular blog posts. Highly encouraged is the creation of individual blog posts for each significant -feature developed, bug fixed, or any notable progress made.] +feature developed, bug fixed, or any notable progress made. }} | Dates | Deliverables/Tasks | | :---- | :----------------- | @@ -76,12 +91,12 @@ feature developed, bug fixed, or any notable progress made.] ## Previous Contributions to the Project -[Summarize your contributions to the project, including the number of merged -PRs, resolved issues, or types of contributions.] +{{ 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.] +{{ List all contributed PRs with titles, numbers, links, and their status. }} | Pull Request Title/Number | Status | | :------------------------ | :----- | @@ -89,13 +104,14 @@ PRs, resolved issues, or types of contributions.] ## Why This Project? -[Explain your motivation for choosing this project.] +{{ Explain your motivation for choosing this project. }} ## Availability -[Confirm your availability during the GSoC period, including weekly hours, other -commitments, and a plan for catching up if behind schedule.] +{{ Confirm your availability during the GSoC period, including weekly hours, other +commitments, and a plan for catching up if behind schedule. }} ## Post-GSoC -[Outline any plans for continuing contributions to the project post GSoC.] +{{ Outline any plans for continuing contributions to the project post GSoC. }} +``` diff --git a/pages/opportunities/gsoc/templates/project-ideas.md b/pages/opportunities/gsoc/templates/project-ideas.md new file mode 100644 index 000000000..a453edc2d --- /dev/null +++ b/pages/opportunities/gsoc/templates/project-ideas.md @@ -0,0 +1,81 @@ +--- +title: "TEMPLATE: GSoC Project Idea" +description: "TEMPLATE: GSoC Project Idea" +date: "2025-01-13" +authors: ["OSL Team"] +template: single-sidebar.html +--- + +# GSoC Project Idea Template + + + +```md +# {{ PROJECT/LIBRARY/TOOL NAME }} + +## Project Idea {{ PROJECT NUMBER }}: {{ TITLE }} + +### Abstract + +{{ ABSTRACT }} + +### License + +{{ LICENSE NAME }}: {{ LINK TO THE LICENSE FILE }} + +### Code of Conduct + +{{ LINK TO THE CODE OF CONDUCT }} + +### Current State + +- {{ BRIEF EXPLANATION ABOUT THE CURRENT STATE OF THE PROJECT }} + +### Tasks + +- {{ LIST OF THE GITHUB/GITLAB ISSUES }} + +### Expected Outcomes + +- {{ LIST OF THE EXPECTED OUTCOMES }} + +### Details + +- Prerequisites: + - {{ LIST OF ALL HARD AND SOFT SKILLS NECESSARY FOR WORKING ON THE TASKS }} +- Duration: {{ 90, 175 or 350 }} hours +- Complexity: {{ Low, Medium, or High }} +- Potential Mentor(s): {{ MENTOR NAME 1 }}, {{ MENTOR NAME 2 }}, ... + +### References + +- {{ LIST OF REFERENCES, SUCH AS LINKS TO MAIN TECHNOLOGIES, ETC }} + +--- + +{{ IF THERE ARE MORE PROJECTS IDEAS, PLEASE ADD THEM HERE }} +``` diff --git a/theme/css/styles.css b/theme/css/styles.css index b8ce5153b..b473c71f9 100644 --- a/theme/css/styles.css +++ b/theme/css/styles.css @@ -296,20 +296,20 @@ h1:hover .link,h2:hover .link,h3:hover .link,h4:hover .link,h5:hover .link{ opacity:1 } h1{ - font-size:200%; + font-size:175%; font-weight:400 } h2{ - font-size:175% + font-size:150% } h3{ - font-size:150% + font-size:130% } h4{ - font-size:125% + font-size:120% } h5{ - font-size:120% + font-size:110% } h6{ font-size:100%