From f996fe8b26341c77a4ddd5084845329fcb0e23ef Mon Sep 17 00:00:00 2001 From: Ivan Ogasawara Date: Fri, 1 Dec 2023 13:06:15 -0400 Subject: [PATCH] docs: Add template for the internship projects ideas (#75) --- mkdocs.yml | 1 + .../internship/templates/projects-ideas.md | 55 +++++++++++++++++++ theme/css/styles.css | 5 ++ 3 files changed, 61 insertions(+) create mode 100644 pages/programs/internship/templates/projects-ideas.md diff --git a/mkdocs.yml b/mkdocs.yml index 2951ccf1..b9d224f1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -30,6 +30,7 @@ nav: - Interns Guide: 'programs/internship/guides/interns/index.md' - Mentors Guide: 'programs/internship/guides/mentors/index.md' - "Cycle 2023-01": 'programs/internship/cycles/2023-01.md' + - Projects Ideas Template: 'programs/internship/templates/projects-ideas.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/projects-ideas.md b/pages/programs/internship/templates/projects-ideas.md new file mode 100644 index 00000000..fe79de38 --- /dev/null +++ b/pages/programs/internship/templates/projects-ideas.md @@ -0,0 +1,55 @@ +``` +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 240 hours) +- Potential Mentor(s): [Mentor 1, Mentor 2, ...] + + +### References + +[Include any relevant links or resources for this project idea] + +--- + + diff --git a/theme/css/styles.css b/theme/css/styles.css index 73e3cce8..42bb4dee 100644 --- a/theme/css/styles.css +++ b/theme/css/styles.css @@ -1752,3 +1752,8 @@ a.link { a.page-number.active { background: #0ca5de!important; } + + +.highlight *{ + color: white!important; +}