@@ -2,22 +2,30 @@ Yocto Project Documentation
===========================
This repository contains documentation materials for a variety of the Yocto
-Project components. In particular see the README under documentation/.
+Project components. In particular see the README file under documentation/.
An online version of the documentation can be found at:
- http://yoctoproject.org/documentation
+ https://docs.yoctoproject.org
-Where to Send Patches
-=====================
+Contributing
+============
-When sending single patches, please using something like:
-'git send-email -1 --to docs@lists.yoctoproject.org
+Please refer to our contributor guide here: https://docs.yoctoproject.org/contributor-guide/
+for full details on how to submit changes.
-The To header can be set as default for this repository:
+As a quick guide, patches should be sent to docs@lists.yoctoproject.org
+The git command to do that would be:
-$ git config sendemail.to docs@lists.yoctoproject.org
+ git send-email -M -1 --to docs@lists.yoctoproject.org
-Now you can just do 'git send-email origin/master' to send all local patches.
+The 'To' header can be set as default for this repository:
-Git repository: http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/
+ git config sendemail.to docs@lists.yoctoproject.org
+
+Now you can just do 'git send-email origin/master..' to send all local patches.
+
+Read the documentation/README and documentation/standards.md files
+for rules to follow when contributing to the documentation.
+
+Git repository: https://git.yoctoproject.org/yocto-docs
Mailing list: docs@lists.yoctoproject.org