From 216e98054ee68b5eb612cffa72087c07ce2b57fc Mon Sep 17 00:00:00 2001
From: Deepak Khatri <deepaklorkhatri7@gmail.com>
Date: Sat, 3 Feb 2024 23:09:07 +0530
Subject: [PATCH] Update guide structure
---
contrib/index.rst => guides/contrib.rst | 4 +-
guides/index.rst | 53 ++++++++++++++++++
{contrib => guides}/media/commit-branch.png | Bin
{contrib => guides}/media/commit-changes.png | Bin
{contrib => guides}/media/commit-success.png | Bin
{contrib => guides}/media/commit.png | Bin
.../media/create-merge-request.png | Bin
{contrib => guides}/media/edit-button.png | Bin
{contrib => guides}/media/fork-button.png | Bin
{contrib => guides}/media/fork-project.png | Bin
{contrib => guides}/media/ide.png | Bin
{contrib => guides}/media/make-edits.png | Bin
{contrib => guides}/media/merge-request.png | Bin
.../media/repo-file-folders.png | Bin
guides/mentors.rst | 4 ++
guides/proposal.rst | 4 ++
guides/students.rst | 27 +++++++++
index.rst | 2 +-
18 files changed, 91 insertions(+), 3 deletions(-)
rename contrib/index.rst => guides/contrib.rst (99%)
create mode 100644 guides/index.rst
rename {contrib => guides}/media/commit-branch.png (100%)
rename {contrib => guides}/media/commit-changes.png (100%)
rename {contrib => guides}/media/commit-success.png (100%)
rename {contrib => guides}/media/commit.png (100%)
rename {contrib => guides}/media/create-merge-request.png (100%)
rename {contrib => guides}/media/edit-button.png (100%)
rename {contrib => guides}/media/fork-button.png (100%)
rename {contrib => guides}/media/fork-project.png (100%)
rename {contrib => guides}/media/ide.png (100%)
rename {contrib => guides}/media/make-edits.png (100%)
rename {contrib => guides}/media/merge-request.png (100%)
rename {contrib => guides}/media/repo-file-folders.png (100%)
create mode 100644 guides/mentors.rst
create mode 100644 guides/proposal.rst
create mode 100644 guides/students.rst
diff --git a/contrib/index.rst b/guides/contrib.rst
similarity index 99%
rename from contrib/index.rst
rename to guides/contrib.rst
index 81ede1c..188038a 100644
--- a/contrib/index.rst
+++ b/guides/contrib.rst
@@ -1,7 +1,7 @@
.. _gsoc_contribution_guide:
-Contribution
-#############
+Contribution guide
+###################
`GSoC <https://gsoc.beagleboard.io/>`_ site uses `OpenBeagle Continous Integration (CI) / Continous Development
(CD) <https://docs.gitlab.com/ee/ci/>`_ which is a continuous method of software development, where
diff --git a/guides/index.rst b/guides/index.rst
new file mode 100644
index 0000000..792c5c2
--- /dev/null
+++ b/guides/index.rst
@@ -0,0 +1,53 @@
+.. _gsoc-guides:
+
+Guides
+######
+
+This section includes guides for :ref:`students <student-guide>` & :ref:`mentors <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>`.
+
+.. card::
+ :link: student-guide
+ :link-type: ref
+
+ **GSoC Contributor/Student Guide**
+ ^^^^
+
+ If you want to increase your chances of being accepted into (and succeed during) Google Summer of Code we strongly
+ encourage you to read this guide! It is particularly helpful for tips on writing a good project proposal and how
+ potential contributors should interact with the communities they are interested in working with during the program.
+
+.. card::
+ :link: mentor-guide
+ :link-type: ref
+
+ **Mentor Guide**
+ ^^^^
+
+.. card::
+ :link: mentor-guide
+ :link-type: ref
+
+ **Proposal Guide**
+ ^^^^
+
+.. card::
+ :link: mentor-guide
+ :link-type: ref
+
+ **Contribution Guide**
+ ^^^^
+
+
+
+
+.. toctree::
+ :hidden:
+ :maxdepth: 2
+
+ students
+ mentors
+ proposal
+ contrib
\ No newline at end of file
diff --git a/contrib/media/commit-branch.png b/guides/media/commit-branch.png
similarity index 100%
rename from contrib/media/commit-branch.png
rename to guides/media/commit-branch.png
diff --git a/contrib/media/commit-changes.png b/guides/media/commit-changes.png
similarity index 100%
rename from contrib/media/commit-changes.png
rename to guides/media/commit-changes.png
diff --git a/contrib/media/commit-success.png b/guides/media/commit-success.png
similarity index 100%
rename from contrib/media/commit-success.png
rename to guides/media/commit-success.png
diff --git a/contrib/media/commit.png b/guides/media/commit.png
similarity index 100%
rename from contrib/media/commit.png
rename to guides/media/commit.png
diff --git a/contrib/media/create-merge-request.png b/guides/media/create-merge-request.png
similarity index 100%
rename from contrib/media/create-merge-request.png
rename to guides/media/create-merge-request.png
diff --git a/contrib/media/edit-button.png b/guides/media/edit-button.png
similarity index 100%
rename from contrib/media/edit-button.png
rename to guides/media/edit-button.png
diff --git a/contrib/media/fork-button.png b/guides/media/fork-button.png
similarity index 100%
rename from contrib/media/fork-button.png
rename to guides/media/fork-button.png
diff --git a/contrib/media/fork-project.png b/guides/media/fork-project.png
similarity index 100%
rename from contrib/media/fork-project.png
rename to guides/media/fork-project.png
diff --git a/contrib/media/ide.png b/guides/media/ide.png
similarity index 100%
rename from contrib/media/ide.png
rename to guides/media/ide.png
diff --git a/contrib/media/make-edits.png b/guides/media/make-edits.png
similarity index 100%
rename from contrib/media/make-edits.png
rename to guides/media/make-edits.png
diff --git a/contrib/media/merge-request.png b/guides/media/merge-request.png
similarity index 100%
rename from contrib/media/merge-request.png
rename to guides/media/merge-request.png
diff --git a/contrib/media/repo-file-folders.png b/guides/media/repo-file-folders.png
similarity index 100%
rename from contrib/media/repo-file-folders.png
rename to guides/media/repo-file-folders.png
diff --git a/guides/mentors.rst b/guides/mentors.rst
new file mode 100644
index 0000000..70e0874
--- /dev/null
+++ b/guides/mentors.rst
@@ -0,0 +1,4 @@
+.. _mentor-guide:
+
+Mentor guide
+############
\ No newline at end of file
diff --git a/guides/proposal.rst b/guides/proposal.rst
new file mode 100644
index 0000000..b474e7b
--- /dev/null
+++ b/guides/proposal.rst
@@ -0,0 +1,4 @@
+.. _proposal-guide:
+
+Proposal guide
+###############
\ No newline at end of file
diff --git a/guides/students.rst b/guides/students.rst
new file mode 100644
index 0000000..e41a7ae
--- /dev/null
+++ b/guides/students.rst
@@ -0,0 +1,27 @@
+.. _student-guide:
+
+Student guide
+#############
+
+General requirements
+********************
+
+All projects have the following basic requirements:
+
+1. Students must create accounts on `OpenBeagle <https://openbeagle.org/>`_, `Discord <http://bbb.io/gsocchat>`_ and `Beagle Forum <http://bbb.io/gsocml>`_ prior to creating their application.
+2. All newly generated materials must be released under an `open source license <http://www.opensource.org/licenses>`_. Individual students shall retain copyright on their works.
+3. Students will demonstrate their ability to cross-compile and utilize version control software by creating a “Hello World†application and generating a pull request to `jadonk/gsoc-application <https://github.com/jadonk/gsoc-application/tree/master/ExampleEntryJasonKridner>`_. For assistance, please visit `Discord <http://bbb.io/gsocchat>`_ or utilize the `Beagle Forum <http://bbb.io/gsocml>`_. The “Hello World†application must print your name and the date out in an ARM Linux environment. Freely available emulators may be used to test your application or you can ask anyone on the chat or mailing list to help you test.
+4. All projects will produce reusable software components and will not be “what–I-built-over-my-summer-vacation†projects. Including a hardware component is welcome, but the project deliverable will be software that may be utilized by a wide audience of the `BeagleBoard.org <http://beagleboard.org/>`_ community.
+5. Students will demonstrate their ability to collaborate by creating a project proposal on this site using our :ref:`proposal template <proposal_template>` and utilizing `Discord <http://bbb.io/gsocchat>`_ to collect quotes regarding the usefulness of their proposal to the `BeagleBoard.org <http://beagleboard.org/>`_ community. **Use of Google Docs for proposal development is discouraged due to insufficient revision control and extensive use of computing resources having numerous documents open simultaneously**.
+6. Source code generated during the project must be released on OpenBeagle (and we’ll setup a mirror on `Github.com <http://github.com/>`_).
+7. Students will provide two recorded audio/video presentations uploaded to Youtube or Vimeo (screencasts are appropriate), one near the beginning of the project summarizing their project goals and another in the wrap-up phase to summarize their accomplishments. Examples can be found on `http://beagleboard.org/gsoc <http://beagleboard.org/gsoc>`_. There is no requirement to show your faces or use English.
+
+.. important::
+
+ 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:
+
+ 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
diff --git a/index.rst b/index.rst
index 54d0ee3..eb02dfb 100644
--- a/index.rst
+++ b/index.rst
@@ -137,6 +137,6 @@ GSoC @ BeagleBoard.org
:hidden:
ideas/index
+ guides/index
proposals/index
- contrib/index
projects/index
--
GitLab