From bc6a19d6a765dbc91c090cabddb6dd968378237d Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 3 Jan 2018 16:09:41 -0800 Subject: overview-manual: Added new "overview" manual to YP doc set Fixes [YOCTO #12370] I added all the mechanics for this new "Yocto Project Overview Manual". For now, the manual builds and publishes into the 2.5 area. I used "overview-manual" for the folder name. Makefile properly builds the new manual. The mega-manual.sed file processes links for the new manual. The mega-manual.xml file includes the new manual. The poky.ent file includes a new ENTITY link for the overview manual. All pieces are in place. With this commit, just an overview chapter exists. The remaining content needs to be developed. (From yocto-docs rev: 632ebd4a91920585e736527e070ca8363a00f41b) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../overview-manual/overview-manual-intro.xml | 103 +++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 documentation/overview-manual/overview-manual-intro.xml (limited to 'documentation/overview-manual/overview-manual-intro.xml') diff --git a/documentation/overview-manual/overview-manual-intro.xml b/documentation/overview-manual/overview-manual-intro.xml new file mode 100644 index 0000000000..51a21b6e23 --- /dev/null +++ b/documentation/overview-manual/overview-manual-intro.xml @@ -0,0 +1,103 @@ + %poky; ] > + + + +The Yocto Project Overview Manual +
+ Welcome + + + Welcome to the Yocto Project Overview Manual! + This manual introduces the Yocto Project by providing concepts, + software overviews, best-known-methods (BKMs), and any other + high-level introductory information suitable for a new Yocto + Project user. + + + + The following list describes what you can get from this manual: + + + Major Topic: + Provide a high-level description of this major topic. + + + Major Topic: + Provide a high-level description of this major topic. + + + Major Topic: + Provide a high-level description of this major topic. + + + Major Topic: + Provide a high-level description of this major topic. + + + + + + This manual does not give you the following: + + + Step-by-step Instructions for Development Tasks: + Instructional procedures reside in other manuals within + the Yocto Project documentation set. + For example, the + Yocto Project Development Tasks Manual + provides examples on how to perform various development + tasks. + As another example, the + Yocto Project Application Development and the Extensible Software Development Kit (eSDK) + manual contains detailed instructions on how to install an + SDK, which is used to develop applications for target + hardware. + + + Reference Material: + This type of material resides in an appropriate reference + manual. + For example, system variables are documented in the + Yocto Project Reference Manual. + As another example, the + Yocto Project Board Support Package (BSP) Developer's Guide + contains reference information on BSPs. + + + Detailed Public Information Not Specific to the + Yocto Project: + For example, exhaustive information on how to use the + Source Control Manager Git is better covered with Internet + searches and official Git Documentation than through the + Yocto Project documentation. + + + +
+ +
+ Other Information + + + Because this manual presents information for many different + topics, supplemental information is recommended for full + comprehension. + For additional introductory information on the Yocto Project, see + the Yocto Project Website. + You can find an introductory to using the Yocto Project by working + through the + Yocto Project Quick Start. + + + + For a comprehensive list of links and other documentation, see the + "Links and Related Documentation" + section in the Yocto Project Reference Manual. + +
+ + -- cgit v1.2.3-54-g00ecf