<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<!DOCTYPE bugzilla SYSTEM "https://bugzilla.yoctoproject.org/page.cgi?id=bugzilla.dtd">

<bugzilla version="5.0.6"
          urlbase="https://bugzilla.yoctoproject.org/"
          
          maintainer="it-coreprojects-helpdesk@linuxfoundation.org"
>

    <bug>
          <bug_id>11630</bug_id>
          
          <creation_ts>2017-06-07 22:31:16 +0000</creation_ts>
          <short_desc>Convert dev-manual into pure task manual (how-to)</short_desc>
          <delta_ts>2021-07-15 09:52:04 +0000</delta_ts>
          <reporter_accessible>1</reporter_accessible>
          <cclist_accessible>1</cclist_accessible>
          <classification_id>9</classification_id>
          <classification>Documentation</classification>
          <product>Development Manual</product>
          <component>development</component>
          <version>unspecified</version>
          <rep_platform>x86</rep_platform>
          <op_sys>Multiple</op_sys>
          <bug_status>RESOLVED</bug_status>
          <resolution>OBSOLETE</resolution>
          
          
          <bug_file_loc></bug_file_loc>
          <status_whiteboard></status_whiteboard>
          <keywords></keywords>
          <priority>Medium+</priority>
          <bug_severity>enhancement</bug_severity>
          <target_milestone>3.4</target_milestone>
          
          
          <everconfirmed>1</everconfirmed>
          <reporter name="Scott Rifenbark">srifenbark</reporter>
          <assigned_to name="Michael Opdenacker">michael.opdenacker</assigned_to>
          <cc>bluelightning</cc>
    
    <cc>jefro</cc>
    
    <cc>kristi</cc>
    
    <cc>michael.opdenacker</cc>
    
    <cc>randy.macleod</cc>
    
    <cc>richard.purdie</cc>
    
    <cc>srifenbark</cc>
    
    <cc>stephano</cc>
    
    <cc>tracey.m.erway</cc>
          
          
          <cf_os>---</cf_os>
          <cf_regression_type>---</cf_regression_type>
          
          <cf_docchange>Yes (doc changes required)</cf_docchange>

      

      

      

          <comment_sort_order>oldest_to_newest</comment_sort_order>  
          <long_desc isprivate="0" >
    <commentid>73846</commentid>
    <comment_count>0</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2017-06-07 22:31:16 +0000</bug_when>
    <thetext>Currently the dev-manual is a mix of intro, reference, and task-based documentation.  We want it to be a &quot;how-to&quot; 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.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>73847</commentid>
    <comment_count>1</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2017-06-07 22:33:19 +0000</bug_when>
    <thetext>Some parameters set (2.4 M4)</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>73848</commentid>
    <comment_count>2</comment_count>
    <who name="Henry Bruce">henry.bruce</who>
    <bug_when>2017-06-07 22:35:37 +0000</bug_when>
    <thetext>A proposal for document outline will be created in https://wiki.yoctoproject.org/wiki/Development_Manual_Rework</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>75917</commentid>
    <comment_count>3</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2017-08-16 18:44:11 +0000</bug_when>
    <thetext>Work is being done on this task and will likely take up all available time.

Scott</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>75918</commentid>
    <comment_count>4</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2017-08-16 18:45:50 +0000</bug_when>
    <thetext>Updating to 2.4 M4.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>77104</commentid>
    <comment_count>5</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2017-09-25 15:42:13 +0000</bug_when>
    <thetext>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.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>79575</commentid>
    <comment_count>6</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2018-02-23 16:01:28 +0000</bug_when>
    <thetext>Need some reviews... 

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

This manual is moving toward a &quot;how-to&quot; 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</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>79968</commentid>
    <comment_count>7</comment_count>
    <who name="Kristi">kristi</who>
    <bug_when>2018-03-23 12:08:02 +0000</bug_when>
    <thetext>Setting target to Future because this is an ongoing conversion for this manual. Thanks!</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>80602</commentid>
    <comment_count>8</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2018-05-16 15:24:10 +0000</bug_when>
    <thetext>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 &quot;Building&quot; 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</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>83561</commentid>
    <comment_count>9</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2019-04-16 23:50:29 +0000</bug_when>
    <thetext>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</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>90926</commentid>
    <comment_count>10</comment_count>
    <who name="Michael Opdenacker">michael.opdenacker</who>
    <bug_when>2021-07-15 09:52:04 +0000</bug_when>
    <thetext>Closing this bug as some work as already been done and keeping this kind of bug won&apos;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.</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>