Merge branch 'main' into 'main'

All my merges

See merge request !13

.gitlab-ci.yml

@@ -4,7 +4,7 @@ pages:
   tags:
   - docker-amd64
   script:
-  - sphinx-build -b html . public
+  - "./gitlab-build.sh"
   artifacts:
     paths:
     - public
\ No newline at end of file

README.md

@@ -6,7 +6,7 @@ Status updates for BeagleBoard.org's Google Summer of Code program.
 
 Primary resources:
 
-* [Forum](https://forum.beagleboard.org/c/gsoc)
+* [Forum](https://bbb.io/gsocml)
 * [Live chat](https://bbb.io/gsocchat)
 * [Project documentation template](https://gsoc.beagleboard.io/project-docs-template)
 

_templates/pdf.html

+{% if pages_slug != "index" %}
+    {% for proposal_name in proposals %}
+        {% if pagename == "proposals/"+proposal_name %}
+            <a class="btn btn-danger btn-sm btn-block text-light" role="button" href="{{proposal_name}}.pdf">
+                <i class="fa-solid fa-download"></i> {{proposal_name}}.pdf
+            </a>
+        {% endif %}
+    {% endfor %}
+{% endif %}
\ No newline at end of file

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
 
@@ -26,6 +26,7 @@ author = 'BeagleBoard.org'
 extensions = [
     "sphinx_design",
     "sphinxcontrib.youtube",
+    "sphinx_copybutton"
 ]
 
 templates_path = ['_templates']
@@ -53,9 +54,16 @@ html_css_files = [
     'css/custom.css',
 ]
 
+# Pages entry without primary (left) sidebar
+
+html_sidebars = {
+  "ideas/index": [],
+}
+
 html_theme_options = {
     "header_links_before_dropdown": 4,
-     "icon_links": [
+    "show_prev_next": True,
+    "icon_links": [
         {
             "name": "OpenBeagle",
             "url": "https://openbeagle.org/",
@@ -70,13 +78,13 @@ html_theme_options = {
         },
         {
             "name": "Discord",
-            "url": "https://discord.com/invite/e58xECGWfR",
+            "url": "https://bbb.io/gsocchat",
             "icon": "fa-brands fa-discord",
             "attributes": {"target": "_blank"},
         },
         {
             "name": "Forum",
-            "url": "https://forum.beagleboard.org/c/gsoc",
+            "url": "https://bbb.io/gsocml",
             "icon": "fa-brands fa-discourse",
             "attributes": {"target": "_blank"},
         },
@@ -99,7 +107,7 @@ html_theme_options = {
     "show_toc_level": 1,
     "navbar_align": "right",
     "show_nav_level": 2,
-    "announcement": "Welcome to new site for BeagleBoard.org GSoC 2024 projects!",
+    "announcement": "Welcome to the new site for BeagleBoard.org GSoC 2024 projects!",
     # "show_version_warning_banner": True,
     "navbar_center": ["navbar-nav"],
     "navbar_start": ["navbar-logo"],
@@ -108,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",
@@ -125,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 --
@@ -143,8 +164,9 @@ latex_elements = {
         )
     ),
 }
+
 latex_engine = "xelatex"
 latex_logo = str("_static/images/logo-latex.pdf")
-latex_documents = [
-    ("proposals/template", "template.tex", "Project proposal template 2024", "John Doe", "manual"),
-]
\ No newline at end of file
+latex_documents = []
+for proposal in proposals:
+    latex_documents.append(("proposals/"+proposal, proposal+".tex", "",author, "manual"))

gitlab-build.sh

+#!/bin/bash -xe
+mkdir -p public
+
+echo "**** Updating $PAGES_URL/$VER_DIR ****"
+echo "**** env ****"
+env
+
+# Clean build directory
+make clean BUILDDIR=public
+
+# Render HTML
+make html BUILDDIR=public
+mv public/html/* public/
+
+# Render PDF
+make latexpdf BUILDDIR=public/
+mv public/latex/*.pdf public/proposals
+
+# Cleanup
+echo "**** cleanup ****"
+rm -rf public/doctrees
+rm -rf public/latex
+
+echo "**** env ****"
+env
\ No newline at end of file

guides/contributor.rst

+.. _gsoc-contributor-guide:
+
+Contributor Guide 
+#################
+
+.. youtube:: YN7uGCg5vLg
+    :width: 100%
+    :align: center
+
+General requirements
+********************
+
+All projects have the following basic requirements:
+
+1. Contributors must create accounts on our `OpenBeagle <https://openbeagle.org/>`_, `Discord <https://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 contributors shall retain copyright on their works.
+3. Contributors 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 our `Discord <https://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 <https://www.beagleboard.org/>`_ community.
+5. Contributors will demonstrate their ability to collaborate by creating a project proposal on this site using our :ref:`proposal template <gsoc-proposal-template>` and utilizing our `Discord <https://bbb.io/gsocchat>`_ to collect quotes regarding the usefulness of their proposal to the `BeagleBoard.org <https://www.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 <https://openbeagle.org>`_ (and we’ll setup a mirror on `Github.com <http://github.com/>`_).
+7. Contributors 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 in :ref:`Past_Projects`. 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 be posted by every Monday and must include these outlines:
+
+    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>`_
+
+Student proposals can encompass projects based on the :ref:`ideas page <gsoc-project-ideas>`  or can include personal project ideas, 
+but should be focused on generating a sustainable and reusable open source software component. Previous Google Summer of Code projects show 
+that the key to success is being passionate about your project, so propose something that is extremely interesting to you, even 
+if it is not on this list. We will be glad to help contributors develop ideas into projects via our `Discord <https://bbb.io/gsocchat>`_ 
+and `Forum <https://bbb.io/gsocml>`_. There are many potential project ideas and we will match contributors to projects 
+based on their interests and help scope the proposals to something that can be completed in the Summer of Code timeframe.
+
+.. tip::
+   There are more than a thousand existing projects listed at `Projects Archive <http://www.beagleboard.org/projects>`_. 
+   If you are interested in any of the projects listed on the `BeagleBoard.org <https://www.beagleboard.org/>`_ projects page, 
+   contact the project members to see if there are any aspects of their projects that can be enhanced to create a GSoC project. 
+   There are also several ideas on the `ECE497 class project idea list <https://elinux.org/ECE497_Project_Ideas>`_. 
+   Note, however, we are looking for projects that provide a service to the developer community and aren’t simply “look what cool 
+   thing I made or you can make”. The projects should provide a useful software component for other people to utilize.
+

guides/index.rst

+.. _gsoc-guides:
+
+Guides
+######
+
+This section includes guides for :ref:`contributors <gsoc-contributor-guide>` & :ref:`mentors <gsoc-mentor-guide>` who want to participate 
+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>`.
+
+.. card::
+    :link: gsoc-contributor-guide
+    :link-type: ref
+
+    :fas:`graduation-cap` **Contributor 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: gsoc-mentor-guide
+    :link-type: ref 
+        
+    :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.
+
+.. card:: 
+    :link: gsoc-proposal-guide
+    :link-type: ref 
+        
+    :fas:`file` **Proposal Guide**
+    ^^^^
+
+    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:: 
+    :link: gsoc-site-editing-guide
+    :link-type: ref 
+        
+    :fas:`file-signature` **Site Editing Guide**
+    ^^^^
+
+    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.
+
+
+
+.. toctree:: 
+    :hidden:
+    :maxdepth: 2
+
+    contributor
+    mentor
+    proposal
+    site-editing