Merge branch 'main' of https://git.beagleboard.org/docs/docs.beagleboard.io

50000f71 · Deepak Khatri · b53808ec · 5663fd9c · 50000f71 · 50000f71
Commit 50000f71 authored 1 year ago by Deepak Khatri
--- a/CONTRIB.rst
+++ b/CONTRIB.rst
+.. _contributors:
+
+Contributors
+#############
+
+This is a list of people who have made contributions to BeagleBoard.org unified documentation project.
+
+People are listed alphabetically, as verified with Unix sort:
+
+.. code-block:: shell
+
+    $ grep "^- " CONTRIB.rst | LC_ALL=C sort -u -c -f
+
+
+This is certainly not comprehensive, and if you've been overlooked (sorry!), please open an issue on GitLab or mention it on the forum.
+
+- `Andrei Aldea <https://git.beagleboard.org/andrei1998>`_
+- `Ayush Singh <https://git.beagleboard.org/ayush1325>`_
+- Cathy Wicks
+- `Deepak Khatri <https://git.beagleboard.org/lorforlinux>`_
+- `Dhruva Gole <https://git.beagleboard.org/dhruvag2000>`_
+- `Harshil Bhatt <https://git.beagleboard.org/harshilbhatt2001>`_
+- `Jason Kridner <https://git.beagleboard.org/jkridner/>`_
+- `Jian De <https://git.beagleboard.org/jiande>`_
+- `Joshua Neal <https://git.beagleboard.org/jdneal>`_
+- `Kai Yamada <https://git.beagleboard.org/gpioblink>`_
+- `Krishna Narayanan <https://git.beagleboard.org/Krishna_13>`_
+- `Mark A. Yoder <https://git.beagleboard.org/yoder>`_
+- `Robert Nelson <https://git.beagleboard.org/RobertCNelson>`_
+- `Sabeeh Khan <https://git.beagleboard.org/sabeeh.khan14>`_
+- `Seth N <https://git.beagleboard.org/silver2row>`_
\ No newline at end of file
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -7,15 +7,21 @@ the BeagleBoard.org Foundation at https://git.beagleboard.org/docs/docs.beaglebo
 mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this
 document in a pull request.

-## Code of Conduct
+## Contribution

-This project and everyone participating in it is governed by
-the [BeagleBoard.org Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to
-uphold this code. Please report unacceptable behavior to [coc@bbb.io](mailto:coc@bbb.io) or
-contact one of the administrators on https://forum.beagleboard.org.
+Contributions in any form are appreciated. If you want to contribute to the docs but not sure 
+where to start then you can checkout our contribution documents to help you with your first pull request.

-## FAQ
+### Code of Conduct

-* [Frequently Asked Questions category on the BeagleBoard.org Forum](https://forum.beagleboard.org/c/faq/19)
+This project and everyone participating in it is governed by the [BeagleBoard.org Code of Conduct](https://docs.beagleboard.org/latest/intro/contribution/index.html#code-of-conduct). By participating, you are expected to uphold this code. Please report unacceptable behavior to [coc@bbb.io](mailto:coc@bbb.io) or contact one of the administrators on https://forum.beagleboard.org.
+
+### Style and usage guidelines
+
+If you are new to Sphinx, RST, or git then you can checkout out our [Style and usage guidelines](https://docs.beagleboard.org/latest/intro/contribution/index.html#style-and-usage-guidelines).

 See more at https://docs.beagleboard.org/en/latest/intro/contribution/.
+
+## FAQ
+
+* [Frequently Asked Questions category on the BeagleBoard.org Forum](https://forum.beagleboard.org/c/faq/19)
--- a/boards/beaglebone/ai-64/index.rst
+++ b/boards/beaglebone/ai-64/index.rst
@@ -11,11 +11,6 @@ are all that need to be added to start building performance-optimized embedded a
 expansion possibilities are enabled through familiar BeagleBone® cape headers, with hundreds of open-source 
 hardware examples and dozens of readily available embedded expansion options available off-the-shelf.

-.. admonition:: Contributors
-
-    This work is licensed under a `Creative Commons Attribution-ShareAlike
-    4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__
-
 .. admonition:: OSHWA Certification mark

    .. figure:: images/OSHW_mark_US002120.*
@@ -24,6 +19,13 @@ hardware examples and dozens of readily available embedded expansion options ava
        :alt: BeagleBone AI-64 OSHW Mark

 .. note::
+
+    This work is licensed under a `Creative Commons Attribution-ShareAlike
+    4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__
+
+    Hardware design files can be found at https://git.beagleboard.org/beagleboard/beaglebone-ai-64
+
+.. tip::
    Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. 
    
    Use of either the boards or the design materials constitutes agreement to the T&C including any 

--- a/boards/beaglebone/ai/index.rst
+++ b/boards/beaglebone/ai/index.rst
@@ -3,14 +3,6 @@
 BeagleBone AI
 ###############

-.. admonition:: Contributors
-
-    This work is licensed under a `Creative Commons Attribution-ShareAlike
-    4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__
-
-    All derivative works are to be attributed to `Jason Kridner of
-    BeagleBoard.org <https://beagleboard.org/about/jkridner>`__.
-
 .. admonition:: OSHWA Certification mark

    .. figure:: images/OSHW_mark_US000169.*
@@ -19,6 +11,14 @@ BeagleBone AI
        :alt: BeagleBone AI OSHW Mark

 .. note::
+
+    This work is licensed under a `Creative Commons Attribution-ShareAlike
+    4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__
+
+    Hardware design files can be found at https://git.beagleboard.org/beagleboard/beaglebone-ai
+
+.. tip:: 
+    
    Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. 
    
    Use of either the boards or the design materials constitutes agreement to the T&C including any 

--- a/boards/beaglebone/black/index.rst
+++ b/boards/beaglebone/black/index.rst
@@ -6,11 +6,6 @@ BeagleBone Black
 BeagleBone Black is a low-cost, community-supported development platform for developers and hobbyists. 
 Boot Linux in under 10 seconds and get started on development in less than 5 minutes with just a single USB cable.

-.. admonition:: Contributors
-
-    This work is licensed under a `Creative Commons Attribution-ShareAlike
-    4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__
-
 .. admonition:: OSHWA Certification mark (BeagleBone Black)

    .. figure:: images/OSHW_mark_US000236.*
@@ -25,8 +20,17 @@ Boot Linux in under 10 seconds and get started on development in less than 5 min
        :target: https://certification.oshwa.org/us000011.html
        :alt: BeagleBone Black Wireless OSHW Mark

+.. note:: 
+
+    This work is licensed under a `Creative Commons Attribution-ShareAlike
+    4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__
+
+    Hardware design files can be found at,
+
+    - BeagleBone Black: https://git.beagleboard.org/beagleboard/beaglebone-black
+    - BeagleBone Black Wireless: https://git.beagleboard.org/beagleboard/beaglebone-black-wireless

-.. note::
+.. tip::
    Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. 
    
    Use of either the boards or the design materials constitutes agreement to the T&C including any 

--- a/boards/beaglebone/blue/index.rst
+++ b/boards/beaglebone/blue/index.rst
@@ -15,11 +15,6 @@ robotics by `UCSD Flow Control and Coordinated Robotics Lab <http://robotics.ucs
 `WowWee <http://www.wowwee.com/mip/>`_, `National Instruments LabVIEW <http://www.ni.com/labview/>`_ 
 and of course the `BeagleBoard.org Foundation <https://beagleboard.org/about>`_.

-.. admonition:: Contributors
-
-    This work is licensed under a `Creative Commons Attribution-ShareAlike
-    4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__
-
 .. admonition:: OSHWA Certification mark

    .. figure:: media/OSHW_mark_US000064.*
@@ -27,7 +22,17 @@ and of course the `BeagleBoard.org Foundation <https://beagleboard.org/about>`_.
        :target: https://certification.oshwa.org/us000064.html
        :alt: BeagleBone Blue OSHW Mark

+
 .. note::
+
+    This work is licensed under a `Creative Commons Attribution-ShareAlike
+    4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__
+
+    Hardware design files can be found at https://git.beagleboard.org/beagleboard/beaglebone-blue
+
+
+.. tip::
+
    Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. 
    
    Use of either the boards or the design materials constitutes agreement to the T&C including any 

--- a/boards/beaglebone/index.rst
+++ b/boards/beaglebone/index.rst
@@ -22,12 +22,12 @@ with links to their latest PDF-formatted System Reference Manual and the latest
 included both here and in the downloadable beagleboard-docs.pdf linked on the bottom-left
 of your screen.

-.. admonition:: Contributors
+.. note::

    This work is licensed under a `Creative Commons Attribution-ShareAlike
    4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__

-.. note::
+.. tip::
    Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. 
    
    Use of either the boards or the design materials constitutes agreement to the T&C including any 

--- a/boards/beagleconnect/freedom/index.rst
+++ b/boards/beagleconnect/freedom/index.rst
@@ -17,22 +17,26 @@ over-the-air upgrades (OTA) capability. This MCU provides flexible support for m
  :alt: BeagleConnect™ Freedom board

 .. important::
+   
    This is a work in progress, for latest documentation please 
    visit https://docs.beagleboard.org/latest/

-.. admonition:: Contributors
-
-    This work is licensed under a `Creative Commons Attribution-ShareAlike
-    4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__
-
 .. admonition:: OSHWA Certification mark

    .. figure:: media/OSHW_mark_US002175.*
        :width: 200
        :target: https://certification.oshwa.org/us002175.html
        :alt: BeagleConnect™ Freedom OSHW Mark
-        
+
 .. note::
+
+    This work is licensed under a `Creative Commons Attribution-ShareAlike
+    4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__
+
+    Hardware design files can be found at https://git.beagleboard.org/beagleconnect/freedom
+
+.. tip::
+
    Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. 
    
    Use of either the boards or the design materials constitutes agreement to the T&C including any 

--- a/boards/beagleconnect/index.rst
+++ b/boards/beagleconnect/index.rst
@@ -7,12 +7,13 @@ BeagleConnect

   Currently under development

-.. admonition:: Contributors
+.. note::

    This work is licensed under a `Creative Commons Attribution-ShareAlike
    4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__

-.. note::
+.. tip::
+
    Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. 
    
    Use of either the boards or the design materials constitutes agreement to the T&C including any 

--- a/boards/beagleplay/index.rst
+++ b/boards/beagleplay/index.rst
@@ -7,11 +7,6 @@ BeaglePlay
    This is a work in progress, for latest documentation please 
    visit https://docs.beagleboard.org/latest/

-.. admonition:: Contributors
-
-    This work is licensed under a `Creative Commons Attribution-ShareAlike
-    4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__
-
 .. admonition:: OSHWA Certification mark

    .. figure:: images/OSHW_mark_US002174.*
@@ -31,7 +26,15 @@ BeaglePlay
   |    :alt: BeaglePlay                                |       :alt: BeaglePlay                                  |
   +----------------------------------------------------+---------------------------------------------------------+

-.. note::
+.. note:: 
+
+    This work is licensed under a `Creative Commons Attribution-ShareAlike
+    4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__
+
+    Hardware design files can be found at https://git.beagleboard.org/beagleplay/beagleplay
+
+.. tip::
+   
    Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. 
    
    Use of either the boards or the design materials constitutes agreement to the T&C including any 

--- a/boards/beaglev/ahead/index.rst
+++ b/boards/beaglev/ahead/index.rst
@@ -11,11 +11,6 @@ BeagleV-Ahead
    This is a work in progress, for latest documentation please 
    visit https://docs.beagleboard.org/latest/

-.. admonition:: Contributors
-
-    This work is licensed under a `Creative Commons Attribution-ShareAlike
-    4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__
-
 .. admonition:: OSHWA Certification mark

    .. figure:: media/OSHW_mark_US002535.*
@@ -23,7 +18,15 @@ BeagleV-Ahead
        :target: https://certification.oshwa.org/us002535.html
        :alt: BeagleV-Ahead OSHW Mark

-.. note::
+.. note:: 
+
+    This work is licensed under a `Creative Commons Attribution-ShareAlike
+    4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__
+
+    Hardware design files can be found at https://git.beagleboard.org/beaglev-ahead/beaglev-ahead
+
+.. tip::
+
    Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. 
    
    Use of either the boards or the design materials constitutes agreement to the T&C including any 

--- a/boards/index.rst
+++ b/boards/index.rst
@@ -25,12 +25,13 @@ options that enable almost endless sensing and actuation expansion.
 :ref:`BeagleBoard <beagleboard-boards-home>` is a family of ARM-based, Linux-capable boards where this project
 started.

-.. admonition:: Contributors
+.. note::

    This work is licensed under a `Creative Commons Attribution-ShareAlike
    4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__

-.. note::
+.. tip::
+    
    Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. 
    
    Use of either the boards or the design materials constitutes agreement to the T&C including any 

--- a/boards/pocketbeagle/original/index.rst
+++ b/boards/pocketbeagle/original/index.rst
@@ -3,14 +3,6 @@
 PocketBeagle
 ###################

-.. admonition:: Contributors
-
-   This work is licensed under a `Creative Commons Attribution-ShareAlike
-   4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__
-   
-   - Maintaining author: `Jason Kridner <jkridner@beagleboard.org>`_
-   - Contributing Editor: `Cathy Wicks  <cathy@beagleboard.org>`_
-
 .. admonition:: OSHWA Certification mark

    .. figure:: images/OSHW_mark_US000083.*
@@ -19,6 +11,13 @@ PocketBeagle
        :alt: PocketBeagle OSHW mark

 .. note::
+
+   This work is licensed under a `Creative Commons Attribution-ShareAlike
+   4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__
+
+   Hardware design files can be found at https://git.beagleboard.org/beagleboard/pocketbeagle
+
+.. tip::
    Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. 
    
    Use of either the boards or the design materials constitutes agreement to the T&C including any 

--- a/index.rst
+++ b/index.rst
@@ -34,6 +34,7 @@ Get started engaging the BeagleBoard.org developer community by reading our :ref
   /intro/support/index
   /intro/beagle101/index
   /intro/contribution/index
+   CONTRIB


 Boards