From 6810ed43f2912976125ff272127b665af138490b Mon Sep 17 00:00:00 2001
From: Jason Kridner <jkridner@beagleboard.org>
Date: Thu, 8 Feb 2024 08:47:55 -0500
Subject: [PATCH] reviewed my notes on the merge
---
guides/index.rst | 10 +++++-----
guides/mentor.rst | 2 +-
guides/proposal.rst | 41 +++++++++++++++++++++++++----------------
guides/site-editing.rst | 2 +-
4 files changed, 32 insertions(+), 23 deletions(-)
diff --git a/guides/index.rst b/guides/index.rst
index 70e92dd..52c3867 100644
--- a/guides/index.rst
+++ b/guides/index.rst
@@ -4,7 +4,7 @@ Guides
######
This section includes guides for :ref:`contributors <gsoc-contributor-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
+in GSoC 2024 with `BeagleBoard.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>`.
@@ -26,7 +26,7 @@ a step by step :ref:`contribution guide <gsoc-contribution-guide>`.
:fas:`person-chalkboard` **Mentor Guide**
^^^^
- If you want to mentor for GSoC this year read this short guide made for mentors wondering where to help.
+ If you want to mentor for GSoC this year, read this short guide made for mentors wondering where to help.
.. card::
:link: gsoc-proposal-guide
@@ -35,7 +35,7 @@ a step by step :ref:`contribution guide <gsoc-contribution-guide>`.
:fas:`file` **Proposal Guide**
^^^^
- To create an proposal on ``gsoc.beagleboar.io`` we have provided a reStructuredText template. The tamplate can be used
+ To create an proposal on ``gsoc.beagleboard.io``, we have provided a reStructuredText template. 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::
@@ -45,7 +45,7 @@ a step by step :ref:`contribution guide <gsoc-contribution-guide>`.
:fas:`file-signature` **Site Editing Guide**
^^^^
- For anyone who is looking to make changes to ``gsoc.beagleboard.io`` site, you can checkout our site editing guide. We have
+ For anyone who is looking to make changes to the ``gsoc.beagleboard.io`` site, you can checkout our site editing 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.
@@ -58,4 +58,4 @@ a step by step :ref:`contribution guide <gsoc-contribution-guide>`.
contributor
mentor
proposal
- contrib
\ No newline at end of file
+ site-editing
diff --git a/guides/mentor.rst b/guides/mentor.rst
index c23e5b7..1813a6f 100644
--- a/guides/mentor.rst
+++ b/guides/mentor.rst
@@ -1,6 +1,6 @@
.. _gsoc-mentor-guide:
-Mentor guide
+Mentor Guide
############
.. youtube:: 3J_eBuYxcyg
diff --git a/guides/proposal.rst b/guides/proposal.rst
index e74364c..e6ba143 100644
--- a/guides/proposal.rst
+++ b/guides/proposal.rst
@@ -1,6 +1,6 @@
.. _gsoc-proposal-guide:
-Proposal guide
+Proposal Guide
###############
.. admonition:: Did you know?
@@ -9,24 +9,33 @@ Proposal guide
improving your chances of success, a poorly-written proposal is an easy way to fail. There is much you can
do to ensure that your project proposal catches the attention of organization reviewers in a positive way.
-How to write a successful proposal?
+How to write a successful proposal
***********************************
`BeagleBoard.org <https://www.beagleboard.org/>`_ has received a large number of GSoC student proposals over the years
-that we have participated in the program. Some of these proposals are quite good, but many are poor proposals that would
-not be accepted by any organization participating in GSoC. Unsuccessful proposals often do/have the following:
-
-1. Try to pass off previous school projects as something to do for GSoC. The work has already done, and the project often has very little to do with `BeagleBoard.org hardware <https://www.beagleboard.org/boards>`_.
-2. Roughly a half page of “proposal†that is submitted shortly before the submission deadline. These proposals are usually little more than a name, contact information, and a statement of “I will work hard.â€
-3. A generic proposal that was sent to every other GSoC org that has very few details on deliverables or schedule.
-4. A project idea that was never talked about to the `BeagleBoard.org <https://www.beagleboard.org/>`_ mentors in our `Discord <https://bbb.io/gsocchat>`_ or in `Forum <https://bbb.io/gsocml>`_. The proposal was submitted without ever “meeting†the Beagle community.
-
-In order to be successful, a proposal has to be relevant to `BeagleBoard.org <https://www.beagleboard.org/>`_, a proposal
-topic that the mentors recognize (either from being proposed on :ref:`gsoc-project-ideas` page or from the topic being
-discussed on our `Discord <https://bbb.io/gsocchat>`_ or in `Forum <https://bbb.io/gsocml>`_), and sufficiently
-detailed that the mentors know exactly what you’ll be creating and when it will be done. Successful proposals are also almost
-always shown to mentors via our `Discord <https://bbb.io/gsocchat>`_ or `Forum <https://bbb.io/gsocml>`_ well before the
-submission deadline so that the mentors can comment on it and offer suggestions that improve the proposal.
+that we have participated. Some of these proposals are quite good, but many are poor proposals that would
+not be accepted by any organization participating in GSoC.
+
+How to write an *unsuccessful* proposal
+========================================
+
+Unsuccessful proposals often:
+
+1. Try to pass off previous school projects as something to do for GSoC. The work has already done, and the project often has very little to do with `BeagleBoard.org hardware <https://www.beagleboard.org/boards>`_,
+2. Show up shortly before the submission deadline with only a half page of “proposalâ€, being little more than a name, contact information, and a statement of “I will work hardâ€,
+3. Are generic and sent to every other GSoC org with very few details on deliverables or schedule, or
+4. Introduce an idea that was never talked about to the `BeagleBoard.org <https://www.beagleboard.org/>`_ mentors in our `Forum <https://bbb.io/gsocml>`_ and submitted without ever engaging the Beagle community.
+
+Please be considerate of the time it takes for us to weed out these bad proposals.
+
+Elements of a successful proposal
+==================================
+
+In order to be successful, a proposal has to be:
+
+1. Relevant to `BeagleBoard.org <https://www.beagleboard.org/>`_,
+2. Around a topic that the mentors recognize from being discussed on our `Forum <https://bbb.io/gsocml>`_, possibly on our :ref:`gsoc-project-ideas` page, and sufficiently detailed that the mentors know exactly what you’ll be creating and when it will be done,
+3. Shown to mentors via our `Forum <https://bbb.io/gsocml>`_ well before the submission deadline, so that the mentors can comment on it and offer suggestions that improve the proposal.
.. tip::
Start your proposal early, speak with the mentors often, and dedicate an appropriate amount of time to both thinking
diff --git a/guides/site-editing.rst b/guides/site-editing.rst
index 3f9a26f..8faaa10 100644
--- a/guides/site-editing.rst
+++ b/guides/site-editing.rst
@@ -172,5 +172,5 @@ below shows all the feilds you have to update,
.. image:: media/merge-request.png
:align: center
-Now wait for the review and if comments/requests are raised then you can continue working on the project
+Now wait for a review and, if comments are raised, then you can continue working on the project
until everything looks perfect and your changes are merged in upstream.
--
GitLab