diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-01-03 16:09:41 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-02-14 15:25:27 +0000 |
commit | bc6a19d6a765dbc91c090cabddb6dd968378237d (patch) | |
tree | 2bc9dcc8c60de05f33cba4270c50211339d1d97b /documentation/overview-manual/overview-manual-intro.xml | |
parent | 9f478d13585ca0ae129ffdb71a1b68b0202a2465 (diff) | |
download | poky-bc6a19d6a765dbc91c090cabddb6dd968378237d.tar.gz |
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 <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/overview-manual/overview-manual-intro.xml')
-rw-r--r-- | documentation/overview-manual/overview-manual-intro.xml | 103 |
1 files changed, 103 insertions, 0 deletions
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 @@ | |||
1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" | ||
3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | ||
4 | |||
5 | <chapter id='overview-manual-intro'> | ||
6 | |||
7 | <title>The Yocto Project Overview Manual</title> | ||
8 | <section id='overview-welcome'> | ||
9 | <title>Welcome</title> | ||
10 | |||
11 | <para> | ||
12 | Welcome to the Yocto Project Overview Manual! | ||
13 | This manual introduces the Yocto Project by providing concepts, | ||
14 | software overviews, best-known-methods (BKMs), and any other | ||
15 | high-level introductory information suitable for a new Yocto | ||
16 | Project user. | ||
17 | </para> | ||
18 | |||
19 | <para> | ||
20 | The following list describes what you can get from this manual: | ||
21 | <itemizedlist> | ||
22 | <listitem><para> | ||
23 | <emphasis>Major Topic:</emphasis> | ||
24 | Provide a high-level description of this major topic. | ||
25 | </para></listitem> | ||
26 | <listitem><para> | ||
27 | <emphasis>Major Topic:</emphasis> | ||
28 | Provide a high-level description of this major topic. | ||
29 | </para></listitem> | ||
30 | <listitem><para> | ||
31 | <emphasis>Major Topic:</emphasis> | ||
32 | Provide a high-level description of this major topic. | ||
33 | </para></listitem> | ||
34 | <listitem><para> | ||
35 | <emphasis>Major Topic:</emphasis> | ||
36 | Provide a high-level description of this major topic. | ||
37 | </para></listitem> | ||
38 | </itemizedlist> | ||
39 | </para> | ||
40 | |||
41 | <para> | ||
42 | This manual does not give you the following: | ||
43 | <itemizedlist> | ||
44 | <listitem><para> | ||
45 | <emphasis>Step-by-step Instructions for Development Tasks:</emphasis> | ||
46 | Instructional procedures reside in other manuals within | ||
47 | the Yocto Project documentation set. | ||
48 | For example, the | ||
49 | <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Tasks Manual</ulink> | ||
50 | provides examples on how to perform various development | ||
51 | tasks. | ||
52 | As another example, the | ||
53 | <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink> | ||
54 | manual contains detailed instructions on how to install an | ||
55 | SDK, which is used to develop applications for target | ||
56 | hardware. | ||
57 | </para></listitem> | ||
58 | <listitem><para> | ||
59 | <emphasis>Reference Material:</emphasis> | ||
60 | This type of material resides in an appropriate reference | ||
61 | manual. | ||
62 | For example, system variables are documented in the | ||
63 | <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>. | ||
64 | As another example, the | ||
65 | <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink> | ||
66 | contains reference information on BSPs. | ||
67 | </para></listitem> | ||
68 | <listitem><para> | ||
69 | <emphasis>Detailed Public Information Not Specific to the | ||
70 | Yocto Project:</emphasis> | ||
71 | For example, exhaustive information on how to use the | ||
72 | Source Control Manager Git is better covered with Internet | ||
73 | searches and official Git Documentation than through the | ||
74 | Yocto Project documentation. | ||
75 | </para></listitem> | ||
76 | </itemizedlist> | ||
77 | </para> | ||
78 | </section> | ||
79 | |||
80 | <section id='overview-other-information'> | ||
81 | <title>Other Information</title> | ||
82 | |||
83 | <para> | ||
84 | Because this manual presents information for many different | ||
85 | topics, supplemental information is recommended for full | ||
86 | comprehension. | ||
87 | For additional introductory information on the Yocto Project, see | ||
88 | the <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>. | ||
89 | You can find an introductory to using the Yocto Project by working | ||
90 | through the | ||
91 | <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>. | ||
92 | </para> | ||
93 | |||
94 | <para> | ||
95 | For a comprehensive list of links and other documentation, see the | ||
96 | "<ulink url='&YOCTO_DOCS_REF_URL;#resources-links-and-related-documentation'>Links and Related Documentation</ulink>" | ||
97 | section in the Yocto Project Reference Manual. | ||
98 | </para> | ||
99 | </section> | ||
100 | </chapter> | ||
101 | <!-- | ||
102 | vim: expandtab tw=80 ts=4 | ||
103 | --> | ||