diff --git a/Projects/2010.rst b/Projects/2010.rst
index ecbba19b7cd3f3a70e5b81bf8445fe5bca253573..80c1e93761c775e4fe95351a3354a702eec9b9de 100644
--- a/Projects/2010.rst
+++ b/Projects/2010.rst
@@ -1,7 +1,7 @@
.. _2010:
-GSoC Contribution for 2010
-###########################
+2010
+#####
USB Sniffer
***********
diff --git a/Projects/2013.rst b/Projects/2013.rst
index 1f456fde95293edf860cc1dc30052ec5beda3824..add23a90da8e9a585daec19ac8b9fae8034aca92 100644
--- a/Projects/2013.rst
+++ b/Projects/2013.rst
@@ -1,7 +1,7 @@
.. _gsoc-2013:
-GSoC Contribution for 2013
-##########################
+2013
+#####
Minix I2C Project for BeagleBoard.org
**************************************
diff --git a/Projects/2014.rst b/Projects/2014.rst
index a2925b588e07a58ab411f22d759ed639bc926646..d21a143d9abc330cba421aa64d4cee2b036f4a9d 100644
--- a/Projects/2014.rst
+++ b/Projects/2014.rst
@@ -1,7 +1,7 @@
.. _gsoc-2014:
-GSoC Contribution for 2014
-##########################
+2014
+#####
BotSpeak PRU Firmware
**********************
diff --git a/Projects/2015.rst b/Projects/2015.rst
index ca13c39cb5324c1db728feefebc3509cc805e1bb..d4cf8209c5000a1f1e520cd8e2fd2fca5bb42dd3 100644
--- a/Projects/2015.rst
+++ b/Projects/2015.rst
@@ -1,7 +1,7 @@
.. _gsoc-2015:
-GSoC Contribution for 2015
-##########################
+2015
+#####
Demo Android app using BBBAndroid
***********************************
diff --git a/Projects/2016.rst b/Projects/2016.rst
index 9fc46f8c21ce4c14558854a7c275d99ac2855943..cadd6bab4659440db52cf8e04551c5ee6e967828 100644
--- a/Projects/2016.rst
+++ b/Projects/2016.rst
@@ -1,7 +1,7 @@
.. _gsoc-2016:
-GSoC Contribution for 2016
-##########################
+2016
+#####
Exposing the PRU as an I2C and SPI master Controller
diff --git a/Projects/2017.rst b/Projects/2017.rst
index 5bb0a09b4c5b31d2750af94d00c8bdb4aa62dbce..5b5d16c9ff0febca05873d2c93547897b5a9d099 100644
--- a/Projects/2017.rst
+++ b/Projects/2017.rst
@@ -1,7 +1,7 @@
.. _gsoc-2017:
-GSoC Contribution for 2017
-##########################
+2017
+#####
BeagleBone AVB Stack
**********************
@@ -70,7 +70,7 @@ BeagleBone PRU DMA
:align: center
+----------------------+-------------------------------------------------------------------------+
-| GSoC Contributor | Mentor |
+| GSoC Contributor | Mentor |
+======================+=========================================================================+
| Maciej Sobkowski | Kumar Abhishek , Zubeen Tolani |
+----------------------+-------------------------------------------------------------------------+
diff --git a/Projects/2018.rst b/Projects/2018.rst
index 7d3e95ba5df2e783ebe18077f6a9a14c2c1ef66b..80cf6a05bfd8c77565bfe3e587c78ce40724298b 100644
--- a/Projects/2018.rst
+++ b/Projects/2018.rst
@@ -1,7 +1,7 @@
.. _gsoc-2018:
-GSoC Contribution for 2018
-##########################
+2018
+#####
Beagleboard.org GSoC 2018 Playlist
***********************************
@@ -20,7 +20,7 @@ BeagleBoot
:align: center
+----------------------+-------------------------------------------------------------------------+
-| GSoC Contributor | Mentor |
+| GSoC Contributor | Mentor |
+======================+=========================================================================+
| Ravi Kumar Prasad | Jason Kridner, Abhishek Kumar |
+----------------------+-------------------------------------------------------------------------+
diff --git a/Projects/2019.rst b/Projects/2019.rst
index b3f2005cecc7dd7a7a4ae76044efcb30ec7f8595..01382e50d3bd9115e7f573677544c9f89f886f91 100644
--- a/Projects/2019.rst
+++ b/Projects/2019.rst
@@ -1,7 +1,7 @@
.. _gsoc-2019:
-GSoC Contribution for 2019
-##########################
+2019
+#####
Clickboard Support Under Greybus
*********************************
diff --git a/Projects/2020.rst b/Projects/2020.rst
index 3c5aca7881603564fced2bc19d265534efe39675..d60261296897e75abe9fc47ca193bde66bbad5e3 100644
--- a/Projects/2020.rst
+++ b/Projects/2020.rst
@@ -1,7 +1,7 @@
.. _gsoc-2020:
-GSoC Contribution for 2020
-##########################
+2020
+#####
PRU Improvements
*****************
diff --git a/Projects/2021.rst b/Projects/2021.rst
index edebd0b0eeb4e27393a4e1597b70e61549a0ea53..1af2ff080a4bf11093673b9fb58ae69c499a9f50 100644
--- a/Projects/2021.rst
+++ b/Projects/2021.rst
@@ -1,7 +1,7 @@
.. _gsoc-2021:
-GSoC Contribution for 2021
-##########################
+2021
+#####
Improvements to simpPRU
************************
diff --git a/Projects/2022.rst b/Projects/2022.rst
index f4378b41df8fa0088889f182b50da99da70e8f6e..7205d4291ebb0c4df7b4187c01eecfcbf577f912 100644
--- a/Projects/2022.rst
+++ b/Projects/2022.rst
@@ -1,7 +1,7 @@
.. _gsoc-2022:
-GSoC Contribution for 2022
-##########################
+2022
+#####
Adding features to simpPRU
***************************
diff --git a/Projects/2023.rst b/Projects/2023.rst
index 1c9fd8e61fbc19362ba2d0e185c6dd6630a15fa4..1c1aa3b382b5cf3bebf669221cda1edf27751e1f 100644
--- a/Projects/2023.rst
+++ b/Projects/2023.rst
@@ -1,7 +1,7 @@
.. _gsoc-2023:
-GSoC Contribution for 2023
-##########################
+2023
+####
Replace Gbridge
****************
diff --git a/Projects/index.rst b/Projects/index.rst
index eb3797ea129df927f93937de1a9e129bb95e8ee6..395515abe963fb05a32cd2709bd467e9175854fc 100644
--- a/Projects/index.rst
+++ b/Projects/index.rst
@@ -1,16 +1,15 @@
.. _Past_Projects:
-Past Successful Projects
-#########################
+Archive
+########
-An overview of the significant contributions made to BeagleBoard through
+An overview of the significant contributions made to BeagleBoard.org through
GSoC over the previous years is given in the section that follows.
These initiatives cover a variety of topics, such as software optimizations
and firmware upgrades.
.. toctree::
:maxdepth: 2
- :caption: List of Projects
2023
2022
diff --git a/conf.py b/conf.py
index bd20303cc9e5ad91cbabe481edc46e63a0288484..3c883c227b5a9bde263c349db0bfb16dd4c6a868 100644
--- a/conf.py
+++ b/conf.py
@@ -24,7 +24,8 @@ author = 'BeagleBoard.org'
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
- "sphinx_design" ,"sphinxcontrib.youtube" ,
+ "sphinx_design",
+ "sphinxcontrib.youtube",
]
templates_path = ['_templates']
@@ -106,7 +107,7 @@ html_theme_options = {
"navbar_end": ["theme-switcher", "navbar-icon-links"],
# "navbar_persistent": ["search-button"],
"footer_start": ["copyright"],
- "footer_center": ["sphinx-version"],
+ "footer_end": ["last-updated"],
# "content_footer_items": ["last-updated"],
}
diff --git a/contrib/index.rst b/contrib/index.rst
new file mode 100644
index 0000000000000000000000000000000000000000..ea78709242c6358bf3327e42b7f9a3d05cad307c
--- /dev/null
+++ b/contrib/index.rst
@@ -0,0 +1,159 @@
+.. _gsoc_contribution_guide:
+
+Contribution
+#############
+
+`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
+you continuously build, test, deploy, and monitor iterative code changes. which means you don't have to setup
+anything on your local machine to update anything on the site. To contribute to this site, you can follow the
+simple steps provided below.
+
+.. note:: `OpenBeagle <https://openbeagle.org/>`_ is a self hosted instance of OpenSource program called `GitLab <https://about.gitlab.com/>`_.
+
+Fork the project
+*****************
+
+Go to `gsoc.beagleboard.io repo on OpenBeagle <https://openbeagle.org/gsoc/gsoc.beagleboard.io>`_
+and click on fork button create a fork on your personal OpenBeagle profile.
+
+.. image:: media/fork-button.png
+ :align: center
+
+After clicking on the fork button, you'll be taken to a page like shown below where you have to,
+
+1. Select your profile from the dropdown.
+2. Click on fork project button to initiate the forking process.
+
+.. image:: media/fork-project.png
+ :align: center
+
+Select file to edit
+*******************
+
+After successfully forking the project you have to,
+
+1. Make sure you are on the forked repo on your profile, it should be ``https://openbeagle.org/<user-name>/gsoc.beagleboard.io`` where <user-name> should be replaced with your OpenBeagle username.
+2. Select any file you want to edit from the files & folders view of the repo page.
+
+.. image:: media/repo-file-folders.png
+ :align: center
+
+After selecting the file you have to click on ``edit button`` and then choose either of the options from drop-down,
+
+1. ``Open in Web IDE``, choose this if you want to work on multiple files.
+2. ``Edit single file``, choose this if you want to make some small edits in a single file.
+
+.. image:: media/edit-button.png
+ :align: center
+
+.. note::
+ Choosing Web IDE will load a `Visual Studio Code Server <https://code.visualstudio.com/docs/remote/vscode-server>`_
+ instance which is a feature rich source code editor. Depending on the internent connection your machine will take some to
+ load the editor and it can be a bit heavy for some machines to handle. Once fully loaded it should run smoothly but, if that is
+ not the case then please consider using single file editor option. Considering majority of the users will be using Web IDE option,
+ we are using the Web IDE for the rest of this guide.
+
+Start editing
+*************
+
+If you select to open your file in web IDE you'll see a familar interface. The GitLab web IDE is actually a rich
+`Visual Studio Code Server <https://code.visualstudio.com/docs/remote/vscode-server>`_ hosted on OpenBeagle.
+
+.. image:: media/ide.png
+ :align: center
+
+.. tip:: We use `reStructuredText (RST) <https://en.wikipedia.org/wiki/ReStructuredText>`_ for all of our documentation projects
+ including `this GSoC site <https://gsoc.beagleboard.io/>`_ and `main docs site <https://docs.beagleboard.org/latest/>`_.
+ If you are new to reStructuredText you can checkout our `reStructuredText cheatsheet <https://docs.beagleboard.org/latest/
+ intro/contribution/rst-cheat-sheet.html>`_ to get yourself familiar with reStructuredText.
+
+.. admonition:: Why not use Markdown for documentation?
+
+ Because reStructuredText stands out against Markdown as,
+
+ 1. It’s more fully-featured.
+ 2. It’s much more standardized and uniform.
+ 3. It has built-in support for extensions.
+
+ For more detailed comparison you can checkout `this article on reStructuredText vs. Markdown for technical
+ documentation <https://eli.thegreenplace.net/2017/restructuredtext-vs-markdown-for-technical-documentation/>`_
+
+
+
+Now you have to select a file and start editing. Below image shows some,
+
+1. Edits made to the `ideas/index.rst` highlighted with green bar on left side of code editor window near line numbers.
+2. Source control button indicating (1) file updated in the repo.
+
+.. image:: media/make-edits.png
+ :align: center
+
+.. tip:: Just like you do on your normal Visual Studio Code desktop application, to commit your changes you can either
+ click on Source control ( :fa:`code-branch;pst-color-secondary` ) button or press ``CTRL + SHIFT + G`` to see all the edited fils.
+
+After swithing to source control you have to,
+
+1. Add a commit message in the input feild.
+2. Click on ``Commit to main`` button or click on drop down button to choose ``Commit to new branch``.
+
+.. image:: media/commit-changes.png
+ :align: center
+
+After clicking ``Commit to 'main'`` button you'll be prompted with a window (shown below) with three options,
+
+1. ``Create new branch``
+2. ``Cancel``
+3. ``Continue``
+
+Click on ``Continue`` button if you want to commit to main (default branch) if it's a single edit or commit.
+Click on ``Create new branch`` if you want to create a new branch and want to keep your main branch clean. Advantage
+of creating a new branch is that assigned reviewer for a pull request / merge request can also add commits to your
+newly created branch which is not possible for your main branch because it's a `protected branch <https://docs.gitlab.com/
+ee/user/project/protected_branches.html>`_ by default.
+
+.. image:: media/commit-branch.png
+ :align: center
+
+When all done right, the lower right side of the ``Web IDE`` you'll a prompt showing ``Success! Your changes have been committed`` message with
+two button,
+
+1. ``Got to Project``
+2. ``Continue working``
+
+.. image:: media/commit-success.png
+ :align: center
+
+If you click on ``Go to Project`` button, you'll see the commit successfully applied as shown in the red box in the image below and the
+green tick shows on the right side indicates that the CI build was also successful.
+
+.. image:: media/commit.png
+ :align: center
+
+.. admonition:: Congratulations!!
+
+ You have made a valuable contribution to an OpenBeagle project!
+
+Create a pull request
+**********************
+
+After making your changes and commiting them to your forked repo, you are set to create a new `pull request / merge request
+<https://en.wikipedia.org/wiki/Distributed_version_control#Pull_requests>`_ so that those changes can be merged to upstream
+repo. To start your new PR click on the dedicated button to create a new merge request and fill out all the details. The image
+below shows all the feilds you have to update,
+
+1. Provided a good title that reflects your work.
+2. Add a detailed description of the work you have done. Add pictures whenever seems useful.
+3. (Optional) you can assign it to yourself if you'll be working on further updates or assign it to someone else who might want to work on the comments we may provide on your work.
+4. Add ``lorforlinux`` or ``jkridner`` as reviewer for PRs with site content update or add your mentor as reviewer if it's related to project work / proposal.
+5. If you want your commits to be shows as a single commit then you can choose the ``sqash commits ...`` check box.
+6. Check if all your commits are shown in the bottom of the screen and if everything looks okay then click on ``Create merge request`` button.
+
+.. tip:: If you are still working on some updates, you may also choose ``Mark as draft`` checkbox (below title)
+ which indicates that you are seeking feedback before making your commits suitable to merge.
+
+.. 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
+until everything looks perfect and your changes are merged in upstream.
\ No newline at end of file
diff --git a/contrib/media/commit-branch.png b/contrib/media/commit-branch.png
new file mode 100644
index 0000000000000000000000000000000000000000..a12463e10c19ec0c29431ad12d8a4b368e91f967
Binary files /dev/null and b/contrib/media/commit-branch.png differ
diff --git a/contrib/media/commit-changes.png b/contrib/media/commit-changes.png
new file mode 100644
index 0000000000000000000000000000000000000000..3d80b552c594f6eb9aabe9fd2388c221b90e2d1c
Binary files /dev/null and b/contrib/media/commit-changes.png differ
diff --git a/contrib/media/commit-success.png b/contrib/media/commit-success.png
new file mode 100644
index 0000000000000000000000000000000000000000..f0f3410e4cf6e8ca4d0d852a81c7a12c0b428f49
Binary files /dev/null and b/contrib/media/commit-success.png differ
diff --git a/contrib/media/commit.png b/contrib/media/commit.png
new file mode 100644
index 0000000000000000000000000000000000000000..5e27c2f65ab4b15f3905fdaeb764cffc10900d5a
Binary files /dev/null and b/contrib/media/commit.png differ
diff --git a/contrib/media/create-merge-request.png b/contrib/media/create-merge-request.png
new file mode 100644
index 0000000000000000000000000000000000000000..3b89ad093b95451e1512c5bd1d1c071b4a3c14bf
Binary files /dev/null and b/contrib/media/create-merge-request.png differ
diff --git a/contrib/media/edit-button.png b/contrib/media/edit-button.png
new file mode 100644
index 0000000000000000000000000000000000000000..c7e51766ad8ee467f2fcd5e15c0d60bc7db5b96c
Binary files /dev/null and b/contrib/media/edit-button.png differ
diff --git a/contrib/media/fork-button.png b/contrib/media/fork-button.png
new file mode 100644
index 0000000000000000000000000000000000000000..d5d078b9fa50aee37f326b94ea44e462789bf753
Binary files /dev/null and b/contrib/media/fork-button.png differ
diff --git a/contrib/media/fork-project.png b/contrib/media/fork-project.png
new file mode 100644
index 0000000000000000000000000000000000000000..dd8b4cc751211db19c008d0bc8ee3a7063cecded
Binary files /dev/null and b/contrib/media/fork-project.png differ
diff --git a/contrib/media/ide.png b/contrib/media/ide.png
new file mode 100644
index 0000000000000000000000000000000000000000..7b1a5036e0174c3d25c76b39d8d9a08e1b02cf3d
Binary files /dev/null and b/contrib/media/ide.png differ
diff --git a/contrib/media/make-edits.png b/contrib/media/make-edits.png
new file mode 100644
index 0000000000000000000000000000000000000000..df9a7c93a0906d7fcee5608be0723bc96fb35560
Binary files /dev/null and b/contrib/media/make-edits.png differ
diff --git a/contrib/media/merge-request.png b/contrib/media/merge-request.png
new file mode 100644
index 0000000000000000000000000000000000000000..53ef387c178ed5d29b0591c43553bbc14e592768
Binary files /dev/null and b/contrib/media/merge-request.png differ
diff --git a/contrib/media/repo-file-folders.png b/contrib/media/repo-file-folders.png
new file mode 100644
index 0000000000000000000000000000000000000000..654285e84a5b4180fac8f5c114432b8c04c50633
Binary files /dev/null and b/contrib/media/repo-file-folders.png differ
diff --git a/ideas/index.rst b/ideas/index.rst
index 7ccdda713fdd91753e12f43cd4eea781414f23ba..7d33982bf205e5198787e9e1b22abe51c65e1484 100644
--- a/ideas/index.rst
+++ b/ideas/index.rst
@@ -1,12 +1,18 @@
.. _gsoc-project-ideas:
-Project Ideas
-#############
+Ideas
+######
Below are the project ideas for the GSoC 2024 sorted for better navigation. The BeagleBoard.org community is loaded
with experts on building open source embedded systems. An embedded system is build of computers
dedicated a specific collections of functions and connected to automate things in the physical world.
+.. important::
+ BeagleaBoard.org is a community centric organization and we keep all of our discussion open for our
+ community on `forum <https://forum.beagleboard.org/>`_. Discussion for all the ideas/projects will
+ be done via `forum <https://forum.beagleboard.org/>`_ as well and must be open for everyone to access. **No
+ direct messages should be sent to mentors or community members until unless there is a private matter.**
+
All the projects have colorful badges for making your choice easier,
.. table::
diff --git a/index.rst b/index.rst
index bde2b3eed37cc1f986cb831df1b4a2dc306963e6..2a93db42276525930d6cfb30a4c118bf252f703a 100644
--- a/index.rst
+++ b/index.rst
@@ -108,6 +108,7 @@ Work on awesome OpenSource projects this summer with BeagleBoard.org!
:caption: Project Ideas
ideas/index
+ contrib/index
.. toctree::
:maxdepth: 2