mirror of
https://git.yoctoproject.org/poky
synced 2026-09-20 12:49:33 +02:00
33b3f081f0
These two links contain more introductory resources to the project and are external to yocto-docs, but currently break the flow of the introduction: - The "Yocto Project Technical Overview" from https://www.yoctoproject.org is essentially the same as our "Introducing the Yocto Project" section of the Overview and Concepts manual but with less details. - The Tips and Tricks wiki page contains a lot of old and obsolete information, and the wiki is bound to be deprecated at some point. Additionally, hide them from the sidebar by not including them in a toctree. (From yocto-docs rev: ddced6aa15828cfc127e5678ff2e8f64087d250a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit a23f8a921a56ded065bf94bc52e26f280e83c949) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Paul Barker <paul@pbarker.dev>
106 lines
2.8 KiB
ReStructuredText
106 lines
2.8 KiB
ReStructuredText
.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
|
|
|
|
.. The Yocto Project documentation master file, created by
|
|
sphinx-quickstart on Mon Apr 13 09:38:33 2020.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
==========================================
|
|
Welcome to the Yocto Project Documentation
|
|
==========================================
|
|
|
|
This is the top level of the Yocto Project documentation tree. The Yocto Project
|
|
documentation is always a work in progress, just like the Yocto Project itself.
|
|
Improvements to the documentation are always welcome; join the
|
|
:yocto_lists:`docs mailing list </g/docs>` if you want to help out.
|
|
|
|
Introduction and Overview
|
|
=========================
|
|
|
|
Get started using the Yocto Project.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Introduction and Overview
|
|
|
|
Quick Build <brief-yoctoprojectqs/index>
|
|
what-i-wish-id-known
|
|
transitioning-to-a-custom-environment
|
|
|
|
Get familiar with the development environment and concepts of the Yocto Project.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
Overview and Concepts <overview-manual/index>
|
|
|
|
Additional introductory resources.
|
|
|
|
- `Technical Overview (external website) <https://www.yoctoproject.org/development/technical-overview/>`__
|
|
- `Tips and Tricks Wiki (external website) <https://wiki.yoctoproject.org/wiki/TipsAndTricks>`__
|
|
|
|
Contributing to the Yocto Project
|
|
=================================
|
|
|
|
Guides on how to contribute to the different parts of the Yocto Project.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Contributor Guide
|
|
|
|
Contributor Guide <contributor-guide/index>
|
|
|
|
Manuals
|
|
=======
|
|
|
|
A collection of manuals covering many aspects of the Yocto Project, including
|
|
reference definitions, tutorials, and details about the project's
|
|
infrastructure.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Manuals
|
|
|
|
Reference Manual <ref-manual/index>
|
|
Board Support Package (BSP) Developer's guide <bsp-guide/index>
|
|
Development Tasks Manual <dev-manual/index>
|
|
Linux Kernel Development Manual <kernel-dev/index>
|
|
Profile and Tracing Manual <profile-manual/index>
|
|
Application Development and the Extensible SDK (eSDK) <sdk-manual/index>
|
|
Toaster Manual <toaster-manual/index>
|
|
Test Environment Manual <test-manual/index>
|
|
bitbake
|
|
|
|
Security Reference
|
|
==================
|
|
|
|
Security-related processes and contact information for vulnerability reporting.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Security Reference
|
|
|
|
Yocto Project Security Reference <security-reference/index>
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Release Manuals
|
|
:hidden:
|
|
|
|
Release Information <migration-guides/index>
|
|
releases
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Documentation Index
|
|
:hidden:
|
|
|
|
genindex
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Documentation Downloads
|
|
:hidden:
|
|
|
|
downloads
|