Commit Graph

5 Commits

Author SHA1 Message Date
Scott Rifenbark
f476125b50 poky.ent: Added YOCTO_DOCS_OM_URL entity
The variabe for the "getting-started" manual goes away and is
replaced by this one for the new "overview-manual."

(From yocto-docs rev: 45fc9beac6db4c40c3660fc9e54cc11e9c1f96c4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:46 +01:00
Scott Rifenbark
ae06e04cd2 documentation: Created new "Getting Started" manual.
Creation involved removing the overview-manual and replacing it
with the getting-started manual.  All links to the string
"&YOCTO_DOCS_OVERVIEW_URL" had to be replaced with
"&YOCTO_DOCS_GS_URL" across the entire YP manual set.  I renamed
files used to create the manual with prefixes suited for the
new manual name, which is "Getting Started With Yocto Project".

The style sheet for the new manual needed updating to display the
new .PNG image for the title page.  The mega-manual file had to
be updated to include the files.  The mega-manual.sed file had
to be updated to include the new manual and not use the overview
manual.

(From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:29 +00:00
Scott Rifenbark
e2060287db overview-manual, ref-manual, dev-manual: Moved x32 stuff
Fixes [YOCTO #12370]

The section on the x32 psABI topic was in the "technical details"
section of the reference manual.  This section combined conceptual
and "how to" information for x32 psABI.  I moved the conceptual
information to a new chapter in the overview-manual.  I moved the
"how-to" information to a separate topic in the dev-manual.  This
resulted in the mega-manual being updated to take on a new chapter
for the overview-manual (overview-concepts.xml).  No links were
affected.

(From yocto-docs rev: 84da28a4ad0f3f89bfc865f410a5d06b57439beb)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Scott Rifenbark
b797db0db4 documentation: Created new YP Overview Manual
Fixes [YOCTO #12370]

Added a new chapter to the newly created Yocto Project Overview
Manual.  This chapter originated from the YP Reference Manual and
was the old chapter 3, which talked a lot about various concepts.
This information is better suited for the new overview manual.

The change involved moving the entire chapter and renaming it.
This move of the content affected many, many external references
and links into the old area.  Consequently, I had to recast all
these links from the different manual.

Changes also included fixing the mega-manual.xml file so that it
would include the new overview manual as part of it.

Many figures had to be relocated as part of the move as well.  This
meant deleting them from the ref-manual/figures folder and putting
them into the overview-manual/figures folder.

(From yocto-docs rev: 87b81358f2bbd02b4a0d966d86c4d7b006d4d78f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Scott Rifenbark
bc6a19d6a7 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>
2018-02-14 15:25:27 +00:00