summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorQuentin Schulz <foss@0leil.net>2020-09-17 01:58:57 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:35 +0100
commitd27ff7ca273538917f00cc1667009c21213085d3 (patch)
tree81a34e1061b087612f8c8502bfc92498798f33d7 /documentation
parentb1dfafa399a4049eafa951e4763d0f1e221c814d (diff)
downloadpoky-d27ff7ca273538917f00cc1667009c21213085d3.tar.gz
sphinx: what-i-wish-id-known: update "don't be fooled by doc search results"
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>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/what-i-wish-id-known.rst26
1 files changed, 11 insertions, 15 deletions
diff --git a/documentation/what-i-wish-id-known.rst b/documentation/what-i-wish-id-known.rst
index 7cf6dfd9a1..cf378747c6 100644
--- a/documentation/what-i-wish-id-known.rst
+++ b/documentation/what-i-wish-id-known.rst
@@ -68,21 +68,17 @@ contact us with other suggestions.
68 use Google to search for Yocto Project concepts or terms, Google consistently 68 use Google to search for Yocto Project concepts or terms, Google consistently
69 searches and retrieves older versions of Yocto Project manuals. For example, 69 searches and retrieves older versions of Yocto Project manuals. For example,
70 searching for a particular topic using Google could result in a "hit" on a 70 searching for a particular topic using Google could result in a "hit" on a
71 Yocto Project manual that is several releases old. To be sure that you are 71 Yocto Project manual that is several releases old. To be sure that you are
72 using the most current Yocto Project documentation, use the 72 using the most current Yocto Project documentation, use the drop-down menu at
73 :yocto_docs:`Yocto Project documentation </>` page to locate the right 73 the top of any of its page.
74 documentation for your software release version. If you use the search bar on 74
75 the top of the Documentation Overview page, while that search isn’t optimal, 75 Many developers look through the :yocto_docs:`All-in-one 'Mega' Manual </singleindex.html>`
76 it will point you to the documents where your search string can be 76 for a concept or term by doing a search through the whole page. This manual
77 found. That search will usually identify where most of the attention on a 77 is a concatenation of the core set of Yocto Project manual. Thus, a simple
78 given term or concept is. 78 string search using Ctrl-F in this manual produces all the "hits" for a
79 79 desired term or concept. Once you find the area in which you are
80 Many developers look through the complete Yocto Project set of manuals for a 80 interested, you can display the actual manual, if desired. It is also
81 concept or term by doing a search through the "Yocto Project Complete 81 possible to use the search bar in the menu or in the left navigation pane.
82 Documentation Set". This manual is a concatenation of the core set of Yocto
83 Project manual. Thus, a simple string search using Ctrl-F in this manual
84 produces all the "hits" for a desired term or concept. Once you find the area
85 in which you are interested, you can display the actual manual, if desired.
86 82
87#. **Understand the basic concepts of how the build system works: the workflow:** 83#. **Understand the basic concepts of how the build system works: the workflow:**
88 Understanding the Yocto Project workflow is important as it can help you both 84 Understanding the Yocto Project workflow is important as it can help you both