Improving the Yocto Project documentation
Channel: Paul Barker
Date: 2020-11-27

In this video I'm looking at the Yocto Project documentation and making some improvements to the sections which describe how to contribute changes to the project. I've also included the process of addressing feedback on the documentation changes after they have been discussed on the mailing list. I've left out the creation of the third version of the patches as there's not much extra to learn from that, it's just putting some final polish on the changes. By the time this video goes live the improved contribution guidelines should be visible in the documentation at https://docs.yoctoproject.org/dev-manual/dev-manual-common-tasks.html#submitting-a-change-to-the-yocto-project.

The published documentation for Yocto Project can be found at https://docs.yoctoproject.org/, for the documentation sources look at the yocto-docs git repository at https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/.

The documentation is written in reStructuredText (https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) and built using Sphinx (https://www.sphinx-doc.org/), it's actually pretty easy to edit the sources and to build a local copy of the documentation to see how your changes look. After making changes to the documentation sources, patches are sent to the relevant mailing list (https://lists.yoctoproject.org/g/docs) and folks have an opportunity to review them. Any feedback on the mailing list should be handled and if necessary an updated set of "v2" patches should be sent to the list. After a few iterations the patches should be in a good state for acceptance into the documentation.

Yocto Project playlist: https://www.youtube.com/playlist?list=PLO6q4-ktclzDqx_P_MZUUpXAEad-Iy6vp

#yoctoproject #linux #embeddedlinux

========================================================================

Twitter: https://twitter.com/pbarker_dev
Website: https://pbarker.dev/

========================================================================

00:00 - Introduction
01:24 - Cloning and building the docs
07:08 - Editing description of testing branches
18:48 - Improving patch submission process docs
31:39 - Patch tidy up & editing readme file
35:37 - Submitting patches
38:57 - Handling patch feedback, using constants and directives
57:39 - Submitting patches v2
01:00:23 - The end