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/figures/overview-title.png | Bin 0 -> 12547 bytes .../eclipse/html/overview-manual/index.html | 93 +++++++++++++++++++++ .../eclipse/html/overview-manual/index.xml | 2 + .../overview-manual/overview-manual-intro.html | 23 +++++ .../overview-other-information.html | 30 +++++++ .../html/overview-manual/overview-welcome.html | 85 +++++++++++++++++++ .../eclipse/overview-manual-toc.xml | 7 ++ 7 files changed, 240 insertions(+) create mode 100644 documentation/overview-manual/eclipse/html/overview-manual/figures/overview-title.png create mode 100644 documentation/overview-manual/eclipse/html/overview-manual/index.html create mode 100644 documentation/overview-manual/eclipse/html/overview-manual/index.xml create mode 100644 documentation/overview-manual/eclipse/html/overview-manual/overview-manual-intro.html create mode 100644 documentation/overview-manual/eclipse/html/overview-manual/overview-other-information.html create mode 100644 documentation/overview-manual/eclipse/html/overview-manual/overview-welcome.html create mode 100644 documentation/overview-manual/eclipse/overview-manual-toc.xml (limited to 'documentation/overview-manual/eclipse') diff --git a/documentation/overview-manual/eclipse/html/overview-manual/figures/overview-title.png b/documentation/overview-manual/eclipse/html/overview-manual/figures/overview-title.png new file mode 100644 index 0000000000..c5ec87242e Binary files /dev/null and b/documentation/overview-manual/eclipse/html/overview-manual/figures/overview-title.png differ diff --git a/documentation/overview-manual/eclipse/html/overview-manual/index.html b/documentation/overview-manual/eclipse/html/overview-manual/index.html new file mode 100644 index 0000000000..a88cde67f0 --- /dev/null +++ b/documentation/overview-manual/eclipse/html/overview-manual/index.html @@ -0,0 +1,93 @@ + + + +Yocto Project Overview Manual + + + + + +
+
+
+

+ + Yocto Project Overview Manual +

+
+
+

+Scott Rifenbark +

+
+ Scotty's Documentation Services, INC
 +
+ +
+
+

Copyright © 2010-2018 Linux Foundation

+
+ +

+ Permission is granted to copy, distribute and/or modify this document under + the terms of the + Creative Commons Attribution-Share Alike 2.0 UK: England & Wales as published by + Creative Commons. +

+
+

Manual Notes

+
    +

  • + This version of the + Yocto Project Overview Manual + is for the 2.5 release of the + Yocto Project. + To be sure you have the latest version of the manual + for this release, use the manual from the + Yocto Project documentation page. +

    • +

  • + For manuals associated with other releases of the Yocto + Project, go to the + Yocto Project documentation page + and use the drop-down "Active Releases" button + and choose the manual associated with the desired + Yocto Project. +

    • +

  • + To report any inaccuracies or problems with this + manual, send an email to the Yocto Project + discussion group at + yocto@yoctoproject.com or log into + the freenode #yocto channel. +

    • +
+
+
+
+ + + + + + +
Revision History
Revision 2.5April 2018
The initial document released with the Yocto Project 2.5 Release.
+
+
+
+
+

Table of Contents

+
+
1. The Yocto Project Overview Manual
+
+
1.1. Welcome
+
1.2. Other Information
+
+
+
+ + + + +
+ diff --git a/documentation/overview-manual/eclipse/html/overview-manual/index.xml b/documentation/overview-manual/eclipse/html/overview-manual/index.xml new file mode 100644 index 0000000000..9edb4b92ac --- /dev/null +++ b/documentation/overview-manual/eclipse/html/overview-manual/index.xml @@ -0,0 +1,2 @@ + + diff --git a/documentation/overview-manual/eclipse/html/overview-manual/overview-manual-intro.html b/documentation/overview-manual/eclipse/html/overview-manual/overview-manual-intro.html new file mode 100644 index 0000000000..a111537108 --- /dev/null +++ b/documentation/overview-manual/eclipse/html/overview-manual/overview-manual-intro.html @@ -0,0 +1,23 @@ + + + +Chapter 1. The Yocto Project Overview Manual + + + + + + + +
+

+Chapter 1. The Yocto Project Overview Manual

+
+

Table of Contents

+
+
1.1. Welcome
+
1.2. Other Information
+
+
+
+ diff --git a/documentation/overview-manual/eclipse/html/overview-manual/overview-other-information.html b/documentation/overview-manual/eclipse/html/overview-manual/overview-other-information.html new file mode 100644 index 0000000000..15e6490e5b --- /dev/null +++ b/documentation/overview-manual/eclipse/html/overview-manual/overview-other-information.html @@ -0,0 +1,30 @@ + + + +1.2. Other Information + + + + + + +
+

+1.2. 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. +

+
+ diff --git a/documentation/overview-manual/eclipse/html/overview-manual/overview-welcome.html b/documentation/overview-manual/eclipse/html/overview-manual/overview-welcome.html new file mode 100644 index 0000000000..6901d0decf --- /dev/null +++ b/documentation/overview-manual/eclipse/html/overview-manual/overview-welcome.html @@ -0,0 +1,85 @@ + + + +1.1. Welcome + + + + + + + +
+

+1.1. 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. +

    • +
+

+

+
+ diff --git a/documentation/overview-manual/eclipse/overview-manual-toc.xml b/documentation/overview-manual/eclipse/overview-manual-toc.xml new file mode 100644 index 0000000000..9dd8da8c4e --- /dev/null +++ b/documentation/overview-manual/eclipse/overview-manual-toc.xml @@ -0,0 +1,7 @@ + + + + + + + -- cgit v1.2.3-54-g00ecf