poky/documentation/concepts-manual/concepts-manual-intro.xml
Scott Rifenbark 39810ff505 documentation: Fixed "Getting Started" manual links
There was inconsistent use when referencing the getting-started
manual.  The manual's name does not include the word
"Manual".  So, I cleaned this up across the manual set and
also in the mega-manual.sed file, which was incorrectly
processing the links to that manual that do not target a
specific section.

(From yocto-docs rev: 0f5321416f7ec50cb6c96cccb7c87ef191a25367)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:44 +01:00

90 lines
4.1 KiB
XML

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<chapter id='concepts-manual-intro'>
<title>The Yocto Project Concepts Manual</title>
<section id='concepts-overview-welcome'>
<title>Welcome</title>
<para>
Welcome to the Yocto Project Concepts Manual!
This manual provides conceptual information that helps you
better understand the Yocto Project.
You can learn about Yocto Project components,
cross-development toolchain generation, shared-state cache,
and many other concepts.
</para>
<para>
This manual does not give you the following:
<itemizedlist>
<listitem><para>
<emphasis>Complete Step-by-step Instructions for Development Tasks:</emphasis>
Instructional procedures reside in other manuals within
the Yocto Project documentation set.
For example, the
<ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Tasks Manual</ulink>
provides examples on how to perform various development
tasks.
As another example, the
<ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink>
manual contains detailed instructions on how to install an
SDK, which is used to develop applications for target
hardware.
</para></listitem>
<listitem><para>
<emphasis>Reference Material:</emphasis>
This type of material resides in an appropriate reference
manual.
For example, system variables are documented in the
<ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>.
As another example, the
<ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>
contains reference information on BSPs.
</para></listitem>
<listitem><para>
<emphasis>Getting Started Material:</emphasis>
This type of material resides in the
<ulink url='&YOCTO_DOCS_GS_URL;'>Getting Started With Yocto Project</ulink>
manual.
</para></listitem>
<listitem><para>
<emphasis>Detailed Public Information Not Specific to the
Yocto Project:</emphasis>
For example, exhaustive information on how to use Git
is better covered with Internet searches and official
Git Documentation than through the Yocto Project
documentation.
</para></listitem>
</itemizedlist>
</para>
</section>
<section id='concepts-overview-other-information'>
<title>Other Information</title>
<para>
Because this manual presents information for many different
concepts, supplemental information is recommended for full
comprehension.
For additional introductory information on the Yocto Project, see
the <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>.
If you want to build an image with no knowledge of Yocto Project
as a way of quickly testing it out, see the
<ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink>
document.
</para>
<para>
For a comprehensive list of links and other documentation, see the
"<ulink url='&YOCTO_DOCS_REF_URL;#resources-links-and-related-documentation'>Links and Related Documentation</ulink>"
section in the Yocto Project Reference Manual.
</para>
</section>
</chapter>
<!--
vim: expandtab tw=80 ts=4
-->