diff --git a/_static/images/favicon.ico b/_static/images/favicon.ico deleted file mode 100644 index e96154d507400f4d1ad0c844a47f9d3455af3917..0000000000000000000000000000000000000000 Binary files a/_static/images/favicon.ico and /dev/null differ diff --git a/_static/images/ideas-below.webp b/_static/images/ideas-below.webp index 018883e7256ff64d0e6a5a1d0f080cdca20987a8..26916bc16d8aca8fa5802a96f2ca97c8a24500bf 100644 Binary files a/_static/images/ideas-below.webp and b/_static/images/ideas-below.webp differ diff --git a/_templates/pdf.html b/_templates/pdf.html new file mode 100644 index 0000000000000000000000000000000000000000..112193b5b50b09558cc04382c46ea28f8f066739 --- /dev/null +++ b/_templates/pdf.html @@ -0,0 +1,10 @@ +{% if pages_slug != "index" %} + {% for proposal_name in proposals %} + {% if pagename == "proposals/"+proposal_name %} + <!-- TODO: Dynamically create custom link for every proposal PDF--> + <a class="btn btn-danger btn-sm btn-block text-light" role="button" href="https://git.beagleboard.org/gsoc/gsoc.beagleboard.io"> + <i class="fa-solid fa-download"></i> {{proposal_name}}.pdf + </a> + {% endif %} + {% endfor %} +{% endif %} \ No newline at end of file diff --git a/conf.py b/conf.py index 6c5bccfa2cd2945f7924e9f0d781c9e15ea51179..e388fa21e6c302b6921719375fd24ef2982b34d6 100644 --- a/conf.py +++ b/conf.py @@ -10,7 +10,7 @@ import os import sys from pathlib import Path from typing import Any, Dict - +from os import walk import pydata_sphinx_theme from sphinx.application import Sphinx @@ -116,8 +116,20 @@ html_theme_options = { "footer_start": ["copyright"], "footer_end": ["last-updated"], # "content_footer_items": ["last-updated"], + "secondary_sidebar_items": { + "**": ["page-toc", "edit-this-page", "sourcelink","pdf"] + } } +proposals = [] +proposal_filenames = next(walk("proposals"), (None, None, []))[2] +for proposal_filename in proposal_filenames: + proposal_filename = os.path.splitext(proposal_filename)[0] + if proposal_filename != "index": + proposals.append(proposal_filename) + +print(proposals) + html_context = { "display_gitlab": True, "gitlab_url": "https://openbeagle.org", @@ -133,6 +145,7 @@ html_context = { "edit_page_url_template": "{{ my_vcs_site }}{{ file_name }}", "edit_page_provider_name": "OpenBeagle", "my_vcs_site": "https://openbeagle.org/gsoc/gsoc.beagleboard.io/-/edit/main/", + "proposals":proposals } # -- Options for proposal PDF generation -- @@ -151,6 +164,7 @@ latex_elements = { ) ), } + latex_engine = "xelatex" latex_logo = str("_static/images/logo-latex.pdf") latex_documents = [ diff --git a/guides/contrib.rst b/guides/contrib.rst index 6e7544ab12861cf5923359b20b5c3480ebd84205..5579d9c9fda1e8d05aa2aca5fe5200ec5073ee59 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 792c5c2b752c254cdd03834f005544bf90735c06..0f2d135218bc12351d43ffd39cbb72c24941ccec 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 0000000000000000000000000000000000000000..a4636e35bf5233fd454e8bcb5ce28ba49cc35a44 --- /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 70e0874cfce98da94f64367294c000dcfd932386..0000000000000000000000000000000000000000 --- 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 b474e7b5646eafc83354d4478f8a9ea4a9c7baca..ff1b568574ce17b0e3aa142f09d9786643ca2dff 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 e41a7ae2e420d44dcd063f7cb0bea82a54128e1a..b8f69d727e94d6f57149a4afa1113afa605276fc 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 diff --git a/ideas/index.rst b/ideas/index.rst index 8ae04efd2eac2769446fcf69dab14707e387a5f0..2ef1a77f36a4bcea489809156389283b0f7d0453 100644 --- a/ideas/index.rst +++ b/ideas/index.rst @@ -48,7 +48,9 @@ in the physical world. Students are expeced to go through the list of ideas below, and check out the corresponding forum link for additional discussions around the idea. -.. grid:: 1 2 2 2 +.. grid:: 1 1 1 2 + :margin: 4 4 0 0 + :gutter: 4 .. grid-item-card:: Low-latency I/O RISC-V CPU core in FPGA fabric :link: https://forum.beagleboard.org/t/low-latency-risc-v-i-o-cpu-core/37156 diff --git a/index.rst b/index.rst index eb02dfb82439840f01126caaa2f74288764e6f22..01f583cd57abb62763aea5dbaf484d728a92e1ff 100644 --- a/index.rst +++ b/index.rst @@ -28,7 +28,9 @@ GSoC @ BeagleBoard.org `Rules page <https://summerofcode.withgoogle.com/rules>`_ and the `FAQ page <https://developers.google.com/open-source/gsoc/faq>`_. -.. grid:: 1 2 2 3 +.. grid:: 1 1 1 3 + :margin: 4 4 0 0 + :gutter: 4 .. grid-item-card:: :link: https://openbeagle.org/ @@ -78,7 +80,9 @@ GSoC @ BeagleBoard.org Get inspiration from some :ref:`Past_Projects`. -.. grid:: 1 1 3 3 +.. grid:: 1 1 1 3 + :margin: 4 4 0 0 + :gutter: 4 .. grid-item-card:: @@ -110,8 +114,10 @@ GSoC @ BeagleBoard.org made cheeseburgers. Check the below projects made by incredible professional innovators for some inspiration. -.. grid:: 1 2 2 2 - +.. grid:: 1 1 2 2 + :margin: 4 4 0 0 + :gutter: 4 + .. grid-item-card:: :fas:`rocket;pst-color-primary` Europa Rover Prototype