From fd6db6656e5bbe31df2e1ae79aa71991ae768252 Mon Sep 17 00:00:00 2001 From: Ivan Ogasawara Date: Tue, 9 Jan 2024 22:38:44 -0400 Subject: [PATCH 1/3] Add intern application template --- .../internship/templates/intern-proposal.md | 98 +++++++++++++++++++ 1 file changed, 98 insertions(+) create mode 100644 pages/programs/internship/templates/intern-proposal.md diff --git a/pages/programs/internship/templates/intern-proposal.md b/pages/programs/internship/templates/intern-proposal.md new file mode 100644 index 000000000..abe2dac4d --- /dev/null +++ b/pages/programs/internship/templates/intern-proposal.md @@ -0,0 +1,98 @@ +``` +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: [Current Candidate's timezone] + +Bio: + +[One or two paragraph with the Candidate's bio] + +## Project Overview + +* Project: [Desired project name] +* Project Idea/Plan: [Desired project idea] +* Expected Time (hours): [Total amount of time to be dedicated for the 3 months] + +### Abstract + +[Abstract of the Project Idea/Plan] + +### Mentors + +[List of mentors for the internship] + +### Implementation Plan + +[According to the project plan/idea, describe the tasks.] + +### Benefits to the Community + +[Describe the benefits for the community/user] + +## Planned Workflow + +[Outline your planned workflow by specifying the project management methodology (e.g., Agile, Scrum) and detailing the frequency and focus of meetings with your mentor. Also, describe how you intend to track progress and manage tasks, ensuring consistent communication and meeting set milestones.] + +## Deliverables + +[List all the expected deliverables for your proposal, such as new features, documentation updates, tutorials, and blog posts. It's advisable to consider writing a blog post for each significant feature implementation or bug fix you plan to accomplish during the internship.] + +## Timeline + +[Detail a comprehensive timeline of your internship, including key dates and associated tasks. This should cover the Community Bonding Period activities, the specific periods allocated to different tasks, scheduled dates for blog post submissions, and the timelines for both the Midterm and Final evaluations.] + +|Dates |Tasks | +|:-----------|:----------------------------| +| | | + +## Previous contributions to the project + +[Describe briefly the contributions to the project. It could be just a summary like the number of PRs merged, or the number of issues resolved, or the type of the contribution such as a bug fix or a documentation update.] + +### Pull Requests + +[List all the PRs (the title, and its number with a link to the github PR) contributed and the status of each one (such as Merged or In-Progress)] + +|Pull Request Title/Number |Status | +|:-------------------------------|:--------| +| | | + + +### Issues + +[List all the Issues (the title, and its number with a link to the github issue) resolved and the status of each one (such as Resolved or In-Progress)] + +|Issue Title/Number |Status | +|:-------------------------------|:--------| +| | | + +## Why this project? + +[Explain why you decided to contribute to this project.] + +## Availability + +[Confirm that you will have the availability to work on the project during all the internship period, mention how much hours you will be available weekly, comment if you will have any other commitment during this internship period. And mention what would be your plan in the case you are behind your proposed timeline.] + +## Post OSL Internship Program + +[Describe what would be your plan (if any) for contribute to the project after the end of your internship program activities.] From 152c4d47118bce3d8b170f24a1e901259361725b Mon Sep 17 00:00:00 2001 From: Ivan Ogasawara Date: Tue, 9 Jan 2024 22:45:50 -0400 Subject: [PATCH 2/3] Improve initial text --- mkdocs.yml | 1 + .../internship/templates/intern-proposal.md | 76 +++++++++---------- 2 files changed, 38 insertions(+), 39 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 03ce28b62..5efad82c0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -36,6 +36,7 @@ nav: - "Cycle 2024-01 (OPEN)": 'programs/internship/cycles/2024-01.md' - "Cycle 2023-01 (CLOSED)": 'programs/internship/cycles/2023-01.md' - Projects Ideas Template: 'programs/internship/templates/projects-ideas.md' + - Intern Project Proposal Template: 'programs/internship/templates/intern-proposal.md' - Mentoring: 'programs/mentoring/index.md' - Packaging Support: 'programs/packaging-support/index.md' - Partners: 'programs/partners/index.md' diff --git a/pages/programs/internship/templates/intern-proposal.md b/pages/programs/internship/templates/intern-proposal.md index abe2dac4d..1442e1727 100644 --- a/pages/programs/internship/templates/intern-proposal.md +++ b/pages/programs/internship/templates/intern-proposal.md @@ -9,90 +9,88 @@ Instructions: 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: [Current Candidate's 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: +**Bio:** -[One or two paragraph with the Candidate's 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 amount of time to be dedicated for the 3 months] +- **Project:** [Desired Project Name] +- **Project Idea/Plan:** [Desired Project Idea] +- **Expected Time (hours):** [Total Time Dedicated Over 3 Months] ### Abstract -[Abstract of the Project Idea/Plan] +[Provide a brief abstract of the project idea/plan.] ### Mentors -[List of mentors for the internship] +[List the mentors for this internship project.] ### Implementation Plan -[According to the project plan/idea, describe the tasks.] +[Describe the tasks according to the project plan/idea.] ### Benefits to the Community -[Describe the benefits for the community/user] +[Explain how the project will benefit the community or users.] ## Planned Workflow -[Outline your planned workflow by specifying the project management methodology (e.g., Agile, Scrum) and detailing the frequency and focus of meetings with your mentor. Also, describe how you intend to track progress and manage tasks, ensuring consistent communication and meeting set milestones.] +[Detail your planned workflow, including the project management methodology, frequency and focus of mentor meetings, progress tracking, and task management strategies.] ## Deliverables -[List all the expected deliverables for your proposal, such as new features, documentation updates, tutorials, and blog posts. It's advisable to consider writing a blog post for each significant feature implementation or bug fix you plan to accomplish during the internship.] +[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 -[Detail a comprehensive timeline of your internship, including key dates and associated tasks. This should cover the Community Bonding Period activities, the specific periods allocated to different tasks, scheduled dates for blog post submissions, and the timelines for both the Midterm and Final evaluations.] +[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 | -|:-----------|:----------------------------| -| | | +| Dates | Tasks | +|:------------|:-----------------------------| +| | | -## Previous contributions to the project +## Previous Contributions to the Project -[Describe briefly the contributions to the project. It could be just a summary like the number of PRs merged, or the number of issues resolved, or the type of the contribution such as a bug fix or a documentation update.] +[Summarize your contributions to the project, including the number of merged PRs, resolved issues, or types of contributions.] ### Pull Requests -[List all the PRs (the title, and its number with a link to the github PR) contributed and the status of each one (such as Merged or In-Progress)] - -|Pull Request Title/Number |Status | -|:-------------------------------|:--------| -| | | +[List all contributed PRs with titles, numbers, links, and their status.] +| Pull Request Title/Number | Status | +|:--------------------------------|:---------| +| | | ### Issues -[List all the Issues (the title, and its number with a link to the github issue) resolved and the status of each one (such as Resolved or In-Progress)] +[List all resolved issues with titles, numbers, links, and their status.] -|Issue Title/Number |Status | -|:-------------------------------|:--------| -| | | +| Issue Title/Number | Status | +|:--------------------------------|:---------| +| | | -## Why this project? +## Why This Project? -[Explain why you decided to contribute to this project.] +[Explain your motivation for choosing this project.] ## Availability -[Confirm that you will have the availability to work on the project during all the internship period, mention how much hours you will be available weekly, comment if you will have any other commitment during this internship period. And mention what would be your plan in the case you are behind your proposed timeline.] +[Confirm your availability during the internship, including weekly hours, other commitments, and a plan for catching up if behind schedule.] -## Post OSL Internship Program +## Post-OSL Internship Program -[Describe what would be your plan (if any) for contribute to the project after the end of your internship program activities.] +[Outline any plans for continuing contributions to the project post-internship.] From 4c17ab83e1cc015a9e8b9277db9fcb881064290e Mon Sep 17 00:00:00 2001 From: Ivan Ogasawara Date: Tue, 9 Jan 2024 22:51:44 -0400 Subject: [PATCH 3/3] update menu and metadata --- mkdocs.yml | 4 ++-- pages/programs/internship/templates/intern-proposal.md | 7 +++++++ pages/programs/internship/templates/projects-ideas.md | 8 ++++++++ 3 files changed, 17 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 5efad82c0..50bdd82b5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -35,8 +35,8 @@ nav: - Mentors Guide: 'programs/internship/guides/mentors/index.md' - "Cycle 2024-01 (OPEN)": 'programs/internship/cycles/2024-01.md' - "Cycle 2023-01 (CLOSED)": 'programs/internship/cycles/2023-01.md' - - Projects Ideas Template: 'programs/internship/templates/projects-ideas.md' - - Intern Project Proposal Template: 'programs/internship/templates/intern-proposal.md' + - "TEMPLATE: Projects Ideas": 'programs/internship/templates/projects-ideas.md' + - "TEMPLATE: Intern Project Proposal": 'programs/internship/templates/intern-proposal.md' - Mentoring: 'programs/mentoring/index.md' - Packaging Support: 'programs/packaging-support/index.md' - Partners: 'programs/partners/index.md' diff --git a/pages/programs/internship/templates/intern-proposal.md b/pages/programs/internship/templates/intern-proposal.md index 1442e1727..c1cd83d8d 100644 --- a/pages/programs/internship/templates/intern-proposal.md +++ b/pages/programs/internship/templates/intern-proposal.md @@ -1,3 +1,10 @@ +--- +title: "TEMPLATE: Intern Project Proposal" +description: "TEMPLATE: Intern Project Proposal" +date: "2024-01-09" +authors: ["OSL Team"] +template: single-sidebar.html +--- ``` Instructions: diff --git a/pages/programs/internship/templates/projects-ideas.md b/pages/programs/internship/templates/projects-ideas.md index fe79de388..5a02b2229 100644 --- a/pages/programs/internship/templates/projects-ideas.md +++ b/pages/programs/internship/templates/projects-ideas.md @@ -1,3 +1,11 @@ +--- +title: "TEMPLATE: Projects Ideas" +description: "TEMPLATE: Projects Ideas" +date: "2023-11-01" +authors: ["OSL Team"] +template: single-sidebar.html +--- + ``` Instructions: