Bug 11630

Summary: Convert dev-manual into pure task manual (how-to)
Product: [Documentation] Development Manual Reporter: Scott Rifenbark <srifenbark>
Component: developmentAssignee: Michael Opdenacker <michael.opdenacker>
Status: RESOLVED OBSOLETE QA Contact:
Severity: enhancement    
Priority: Medium+ CC: bluelightning, jefro, kristi, michael.opdenacker, randy.macleod, richard.purdie, srifenbark, stephano, tracey.m.erway
Version: unspecified   
Target Milestone: 3.4   
Hardware: x86   
OS: Multiple   
Whiteboard:
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Yes (doc changes required)

Description Scott Rifenbark 2017-06-07 22:31:16 UTC
Currently the dev-manual is a mix of intro, reference, and task-based documentation.  We want it to be a "how-to" manual based around tasks that can be grouped into logical areas of interest.  This will affect the dev-manual, the QS, and the ref-manual.

We will work from a wiki that is somewhat of a staging area for identified tasks.
Comment 1 Scott Rifenbark 2017-06-07 22:33:19 UTC
Some parameters set (2.4 M4)
Comment 2 Henry Bruce 2017-06-07 22:35:37 UTC
A proposal for document outline will be created in https://wiki.yoctoproject.org/wiki/Development_Manual_Rework
Comment 3 Scott Rifenbark 2017-08-16 18:44:11 UTC
Work is being done on this task and will likely take up all available time.

Scott
Comment 4 Scott Rifenbark 2017-08-16 18:45:50 UTC
Updating to 2.4 M4.
Comment 5 Scott Rifenbark 2017-09-25 15:42:13 UTC
Setting out to 2.5 as this is going to be an ongoing task.  Much was accomplished during the 2.4 development cycle but more needs to be done.
Comment 6 Scott Rifenbark 2018-02-23 16:01:28 UTC
Need some reviews... 

See http://www.yoctoproject.org/docs/2.5/dev-manual/dev-manual.html

This manual is moving toward a "how-to" manual.  I have gotten the bulk of concepts and reference material out of the book and placed into other manuals. 

Leaving the bug open for some review period.  The book needs to continue to undergo improvement over time.

Scott
Comment 7 Kristi 2018-03-23 12:08:02 UTC
Setting target to Future because this is an ongoing conversion for this manual. Thanks!
Comment 8 Scott Rifenbark 2018-05-16 15:24:10 UTC
I have done some re-organizing of the topics in the dev-manual.  In particular, I have made the second chapter, which is on setting things up to use YP, be just that.  I removed some building topics and got them down into the common tasks chapter. 

Since there were quite a number of topics in the common tasks chapter that had to do with building various things, I created a parent "Building" section and organized those sub-topics within that new section.

Work on this manual continues with the goal of making sure we cover as many tasks and procedures as possible to help the user out.  

Thanks, 
Scott

https://www.yoctoproject.org/docs/2.5/dev-manual/dev-manual.html
Comment 9 Scott Rifenbark 2019-04-16 23:50:29 UTC
The manual is in the final stages of 2.7 as of this comment (see https://www.yoctoproject.org/docs/2.7/dev-manual/dev-manual.html).  It continues to be improved on.

Setting status to IN PROGRESS IMPLEMENTATION to more accurately reflect the live of this bug.

Scott
Comment 10 Michael Opdenacker 2021-07-15 09:52:04 UTC
Closing this bug as some work as already been done and keeping this kind of bug won't help with the general improvement of the documentation. More specific tasks are better, while generic directions belong to the community maintaining the documentation, and need reevaluating from time to time.