diff --git a/intro/contribution/index.rst b/intro/contribution/index.rst index f9e0ce8230db5ba1c21f34e3e80b5da788767180..2905bce1d48bac5606a961c433d4e88446127a28 100644 --- a/intro/contribution/index.rst +++ b/intro/contribution/index.rst @@ -26,10 +26,10 @@ to propose changes to this document in a pull request. Code of Conduct *************** -This project and everyone participating in it is governed by the same code of conduct. +This project and everyone participating are governed by the same code of conduct. .. note:: - Check out https://forum.beagleboard.org/faq as a starting place to unify our code of conduct. + Check out https://forum.beagleboard.org/faq as a starting place for our code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to @@ -38,22 +38,42 @@ contact one of our administrators or moderators on https://forum.beagleboard.org Frequently Asked Questions ************************** +Please refer to the technical and contribution frequently asked questions pages before posting any of your own questions. Please +feel encouraged to ask follow-up questions if any of the answers are not clear enough. + * `Frequently asked questions contribution category on the BeagleBoard.org Forum <https://forum.beagleboard.org/c/faq>`__ What should I know before I get started? **************************************** +The more you know about Linux and contributing to upstream projects, the better, but this knowledge isn't strictly required. Simply +reading about contributing to Linux and upstream projects can help build your vocabulary in a meaningful way to help out. Learn about +Linux contributions in the :ref:`beagleboard-linux-upstream` section. + +The most useful thing to know is how to ask smart questions. Read about this in the :ref:`intro-getting-support` section. If you ask +smart questions on the issue trackers and forum, you'll be doing a lot to help us improve the designs and documentation. + +.. toctree:: + :maxdepth: 1 + :hidden: + + /intro/contribution/linux-upstream + How can I contribute? ********************* +The most obvious way to contribute is using the `git.beagleboard.org Gitlab server <https://git.beagleboard.org>`_ to report +bugs, suggest enhancements and providing merge requests, also called pull requests, the provide fixes to software, hardware +designs and documentation. + Reporting bugs =============== Suggesting enhancements ======================= -Submitting pull requests -======================== +Submitting merge requests +========================= Style and usage guidelines ************************** @@ -68,4 +88,3 @@ Style and usage guidelines /intro/contribution/git-usage /intro/contribution/style - /intro/contribution/linux-upstream diff --git a/intro/support/index.rst b/intro/support/index.rst index f374c31cb6cef7fff8151a709a651508196e49ab..992650418c922e3951f072df7bd3f4a6d3af3bf9 100644 --- a/intro/support/index.rst +++ b/intro/support/index.rst @@ -17,6 +17,7 @@ hardware computers, visit :ref:`beagleboard-getting-started`. /intro/support/getting-started +.. _intro-getting-support: Getting support *************** @@ -36,16 +37,16 @@ there. Be sure to ask `smart questions <http://www.catb.org/~esr/faqs/smart-questions.html>`__ that provide the following: -* What am I trying to accomplish? -* What did find when researching how to accomplish it? -* What are the detailed results of what I tried? -* How did these results differ from what I expected? -* What would I consider to be a success? +* What are you trying to accomplish? +* What did you find when researching how to accomplish it? +* What are the detailed results of what you tried? +* How did these results differ from what you expected? +* What would you consider to be a success? -.. note:: +.. important:: Remember that community developers are volunteering their expertise. If you - want paid support, there are options for that. Respect developers time and - expertise and they might be happy to share with you. + want paid support, there are :ref:`consulting-resources` options for that. Respect + developers time and expertise and they might be happy to share with you. Diagnostic tools ================ @@ -72,6 +73,8 @@ of the entire community. - `Mailing List <https://forum.beagleboard.org>`__ - `Live Chat <https://beagleboard.org/chat>`__ +.. _consulting-resources: + Consulting and other resources ==============================