From 50bb72f66a8d7505cc8dca38983b7266ffe8514a Mon Sep 17 00:00:00 2001
From: Deepak Khatri <deepaklorkhatri7@gmail.com>
Date: Mon, 5 Feb 2024 17:04:03 +0530
Subject: [PATCH] Update guides section
---
guides/contrib.rst | 2 +-
guides/index.rst | 32 +++++++++++++++++-----------
guides/mentor.rst | 8 +++++++
guides/mentors.rst | 4 ----
guides/proposal.rst | 2 +-
guides/{students.rst => student.rst} | 14 +++++++-----
6 files changed, 39 insertions(+), 23 deletions(-)
create mode 100644 guides/mentor.rst
delete mode 100644 guides/mentors.rst
rename guides/{students.rst => student.rst} (87%)
diff --git a/guides/contrib.rst b/guides/contrib.rst
index 6e7544a..5579d9c 100644
--- a/guides/contrib.rst
+++ b/guides/contrib.rst
@@ -1,4 +1,4 @@
-.. _gsoc_contribution_guide:
+.. _gsoc-contribution-guide:
Contribution guide
###################
diff --git a/guides/index.rst b/guides/index.rst
index 792c5c2..0f2d135 100644
--- a/guides/index.rst
+++ b/guides/index.rst
@@ -3,16 +3,16 @@
Guides
######
-This section includes guides for :ref:`students <student-guide>` & :ref:`mentors <mentor-guide>` who want to participate
+This section includes guides for :ref:`students <gsoc-student-guide>` & :ref:`mentors <gsoc-mentor-guide>` who want to participate
in GSoC 2024 with `BeagleaBoard.org <www.beagleboard/org>`_. It's highly recommended to check `GSoC Frequently Asked Questions
<https://developers.google.com/open-source/gsoc/faq>`_. For anyone who just want to contribute to this site we also have
-a step by step :ref:`contribution guide <gsoc_contribution_guide>`.
+a step by step :ref:`contribution guide <gsoc-contribution-guide>`.
.. card::
- :link: student-guide
+ :link: gsoc-student-guide
:link-type: ref
- **GSoC Contributor/Student Guide**
+ :fas:`graduation-cap` **Student Guide**
^^^^
If you want to increase your chances of being accepted into (and succeed during) Google Summer of Code we strongly
@@ -20,26 +20,34 @@ a step by step :ref:`contribution guide <gsoc_contribution_guide>`.
potential contributors should interact with the communities they are interested in working with during the program.
.. card::
- :link: mentor-guide
+ :link: gsoc-mentor-guide
:link-type: ref
- **Mentor Guide**
+ :fas:`person-chalkboard` **Mentor Guide**
^^^^
+ If you want to mentor a students for GSoC this year read this short guide made for mentors wondering where to help.
+
.. card::
- :link: mentor-guide
+ :link: gsoc-proposal-guide
:link-type: ref
- **Proposal Guide**
+ :fas:`file` **Proposal Guide**
^^^^
+ To create an proposal on ``gsoc.beagleboar.io`` we have provided a reStructuredText tempalte. The tamplate can be used
+ to create a live HTML version of the proposal as well as generate a PDF version for GSoC submission.
+
.. card::
- :link: mentor-guide
+ :link: gsoc-contribution-guide
:link-type: ref
- **Contribution Guide**
+ :fas:`file-signature` **Contribution Guide**
^^^^
+ For anyone who is looking to make changes to ``gsoc.beagleboard.io`` site, you can checkout our contribution guide. We have
+ provided information on how to use OpenBeagle's integrated ``Web IDE`` for editing, ``CI`` for building and ``pages`` for
+ serving the rendered content.
@@ -47,7 +55,7 @@ a step by step :ref:`contribution guide <gsoc_contribution_guide>`.
:hidden:
:maxdepth: 2
- students
- mentors
+ student
+ mentor
proposal
contrib
\ No newline at end of file
diff --git a/guides/mentor.rst b/guides/mentor.rst
new file mode 100644
index 0000000..a4636e3
--- /dev/null
+++ b/guides/mentor.rst
@@ -0,0 +1,8 @@
+.. _gsoc-mentor-guide:
+
+Mentor guide
+############
+
+Please start by registering your ideas for student projects below by following the template provided with the existing ideas. Furthermore, scroll down to the bottom and give everyone a bit of information about your expertise and availability by adding yourself to the table. Jason will make final approvals for mentor assignments based on if we first get accepted as a mentoring organization and best matching mentor skill sets with student project ideas deemed valuable to the community.
+
+You will also need be invited by an administrator to register on the GSoC site and request to be a mentor for BeagleBoard.org 8.
\ No newline at end of file
diff --git a/guides/mentors.rst b/guides/mentors.rst
deleted file mode 100644
index 70e0874..0000000
--- a/guides/mentors.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-.. _mentor-guide:
-
-Mentor guide
-############
\ No newline at end of file
diff --git a/guides/proposal.rst b/guides/proposal.rst
index b474e7b..ff1b568 100644
--- a/guides/proposal.rst
+++ b/guides/proposal.rst
@@ -1,4 +1,4 @@
-.. _proposal-guide:
+.. _gsoc-proposal-guide:
Proposal guide
###############
\ No newline at end of file
diff --git a/guides/students.rst b/guides/student.rst
similarity index 87%
rename from guides/students.rst
rename to guides/student.rst
index e41a7ae..b8f69d7 100644
--- a/guides/students.rst
+++ b/guides/student.rst
@@ -1,4 +1,4 @@
-.. _student-guide:
+.. _gsoc-student-guide:
Student guide
#############
@@ -20,8 +20,12 @@ All projects have the following basic requirements:
To help you to break your project down into manageable chunks and also to help the project’s mentors to better support
your efforts, weekly project status reports should be e-mailed to the the `Beagle Forum <http://bbb.io/gsocml>`_.
- Each status report should outline:
+ Each status report should be posted by every Monday and must include these outlines:
- 1. What was accomplished that week,
- 2. Any issues that prevented that week’s goals from being completed and
- 3. your goals for the next week.
\ No newline at end of file
+ 1. Accomplishments
+ 2. Resolutions to blockers
+ 3. On-going blockers
+ 4. Plans for this week
+
+ For example, `Weekly Progress Report Thread:
+ Cape Compatibility <https://forum.beagleboard.org/t/weekly-progress-report-thread-cape-compatibility/28709/9>`_
\ No newline at end of file
--
GitLab