| Summary: | Docs should have pointer to latest manual at the top | ||
|---|---|---|---|
| Product: | [Documentation] General Docs | Reporter: | Richard Purdie <richard.purdie> |
| Component: | docs-general | Assignee: | Scott Rifenbark <srifenbark> |
| Status: | RESOLVED FIXED | QA Contact: | |
| Severity: | normal | ||
| Priority: | Medium | CC: | sgw, srifenbark |
| Version: | unspecified | ||
| Target Milestone: | 2.3 M2 | ||
| Hardware: | x86 | ||
| OS: | Multiple | ||
| Whiteboard: | 05 Feb 2017: RESOLVED | ||
| OS type for building Yocto: | --- | Type of Regression: | --- |
| Verified: | Documentation change: | Done (doc changes complete) | |
|
Description
Richard Purdie
2016-08-03 13:59:41 UTC
With python for example, there are clear selections/indications at the top of the page for 2.x verses 3.x manuals for example. Richard, We have a note at the top of each manual currently but it points to that version. A variable is used to resolve the URL to the manual. The values come from a poky.ent file that uses the "YOCTO_DOCS_VERSION" in there to point to that release. If we put another link using "current" in there as the value for the most recent version of the manual for the most recent YP release, then the manual the user would get by clicking on the note link in a 1.8 manual would resolve to the 2.1 manual right now for example. I think I could alter that note so that it is clear that the manual they are looking at as a result of the title page is a specific version and then include a link to the "current" version of the manual. As long as it is acceptable to jump over major releases (e.g. from 1.7.3 to 2.1). Manual revision tables could be enhanced as well. There are some challenges with those. In general, the list of manuals is restricted to a particular branch. So the 1.8.x manuals do not list 2.0 or 2.1 manuals. Is that what we want? Or do we want to have all manuals listed regardless of major releases? Furthermore, an earlier version of a manual (e.g. 1.8) lists that version as the latest manual in the table when in fact 1.8.1 and 1.8.2 manuals exist. Scott Setting up targets, etc. Moving to 2.3 M2 Any further thoughts on this Richard? Sorry Scott, this got lost in other emails. Currently at the top of the manual you have "For the latest version of this manual associated with this Yocto Project release, see the Yocto Project Mega-Manual from the Yocto Project website.". I think I'd like to see each of the manual have something like this at the top: "For the latest version of this manual associated with this Yocto Project release, see the Yocto Project Mega-Manual from the Yocto Project website here. There may be later releases of the project and the latest release can be found on https://www.yoctoproject.org/documentation. The manual for the latest in-development version of the project are available at http://www.yoctoproject.org/docs/latest/mega-manual/mega-manual.html" So put in links to how to find the latest release (the main docs page) and how to find the latest in progress version. Does that make sense? Richard, See http://www.yoctoproject.org/docs/2.3/yocto-project-qs/yocto-project-qs.html#yocto-project-qs-intro for the QS version of the new note. I would like to agree on the new note before updating the rest of the manuals. Thanks, Scott I need Richard to address Comment 7. Setting to 2.3 M3. Richard, See http://www.yoctoproject.org/docs/2.3/yocto-project-qs/yocto-project-qs.html#yocto-project-qs-intro for your latest suggestions. Thanks, Scott Hi, After consulting with Richard, we determined the best solution for the note at the beginnings of the manuals to more clearly show the current, alternate, and latest versions of the manual depending on the release. Each manual has been updated and the wording approved by Richard Purdie. Marking the bug as RESOLVED and setting the doc flag to "done." Scott |