mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-01-29 21:08:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

sphinx: what-i-wish-id-known: update "don't be fooled by doc search results"

Browse Source 
The release selection for the documentation is fortunately not so complex anymore.

Let's also add a link to the mega-manual instead of just naming it and mention the
search bar as well.

(From yocto-docs rev: 6e46e41a965d2360a41a43263b2c100c5f77541e)

Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Quentin Schulz
2020-09-17 01:58:57 +02:00
committed by Richard Purdie
parent b1dfafa399
commit d27ff7ca27
1 changed files with 10 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
documentation/what-i-wish-id-known.rst
View File

@@ -68,21 +68,17 @@ contact us with other suggestions.
use Google to search for Yocto Project concepts or terms, Google consistently
searches and retrieves older versions of Yocto Project manuals. For example,
searching for a particular topic using Google could result in a "hit" on a
Yocto Project manual that is several releases old. To be sure that you are
using the most current Yocto Project documentation, use the
:yocto_docs:`Yocto Project documentation </>` page to locate the right
documentation for your software release version. If you use the search bar on
the top of the Documentation Overview page, while that search isn’t optimal,
it will point you to the documents where your search string can be
found. That search will usually identify where most of the attention on a
given term or concept is.
Yocto Project manual that is several releases old. To be sure that you are
using the most current Yocto Project documentation, use the drop-down menu at
the top of any of its page.
Many developers look through the complete Yocto Project set of manuals for a
concept or term by doing a search through the "Yocto Project Complete
Documentation Set". This manual is a concatenation of the core set of Yocto
Project manual. Thus, a simple string search using Ctrl-F in this manual
produces all the "hits" for a desired term or concept. Once you find the area
in which you are interested, you can display the actual manual, if desired.
Many developers look through the :yocto_docs:`All-in-one 'Mega' Manual </singleindex.html>`
for a concept or term by doing a search through the whole page. This manual
is a concatenation of the core set of Yocto Project manual. Thus, a simple
string search using Ctrl-F in this manual produces all the "hits" for a
desired term or concept. Once you find the area in which you are
interested, you can display the actual manual, if desired. It is also
possible to use the search bar in the menu or in the left navigation pane.
#. **Understand the basic concepts of how the build system works: the workflow:**
Understanding the Yocto Project workflow is important as it can help you both