Bug 6901

Summary: Produce Toaster manual for 1.8
Product: [Documentation] General Docs Reporter: Belen Barros Pena <belen.barros.pena>
Component: docs-generalAssignee: Scott Rifenbark <srifenbark>
Status: VERIFIED FIXED QA Contact: Valentin Hangan <valentinx.hangan>
Severity: enhancement    
Priority: Medium+ CC: alexandru.c.georgescu, alexandru.damian, alin.dumitru, belen.barros.pena, bluelightning, michael.g.wood, richard.purdie, srifenbark, valentinx.hangan
Version: unspecified   
Target Milestone: 1.8 M4   
Hardware: All   
OS: Multiple   
Whiteboard: 20 February 2015: IN PROGRESS REVIEW
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Done (doc changes complete)

Description Belen Barros Pena 2014-10-28 15:38:56 UTC
With the addition of the build functionality, configuring Toaster has become a bit more convoluted, so it is probably time for us to produce a manual. 

The manual will cover installation and configuration, but not the UI: we will continue producing short videos and using the Yocto Project website for that.
Comment 1 Scott Rifenbark 2014-11-12 12:40:30 UTC
*** Bug 6773 has been marked as a duplicate of this bug. ***
Comment 2 Scott Rifenbark 2014-11-12 12:44:59 UTC
Hi, 

Will we want this new manual to live alongside the YP manuals in the general manuals area of the website or do we want the manual accessible from the Toaster page?

Scott
Comment 3 Belen Barros Pena 2014-11-12 12:51:28 UTC
(In reply to comment #2)
> Hi, 
> 
> Will we want this new manual to live alongside the YP manuals in the general
> manuals area of the website or do we want the manual accessible from the
> Toaster page?

Both? I think the Toaster manual (which will cover installation and configuration) should be with all other manuals, and then we will definitely link to it from all other Toaster content (web pages, wiki, and so on).

> 
> Scott
Comment 4 Scott Rifenbark 2014-11-12 14:51:27 UTC
So I have a general question about all Toaster information.  Do we want it split up across several areas (i.e. wiki and manual), or do we want to collect it together?  Typically, you gather all the information about an application into the manual when there is one.

Scott
Comment 5 Scott Rifenbark 2014-11-12 14:52:16 UTC
Adding Alexandru to the CC list for this bug.
Comment 6 Belen Barros Pena 2014-11-12 14:55:33 UTC
(In reply to comment #4)
> So I have a general question about all Toaster information.  Do we want it
> split up across several areas (i.e. wiki and manual), or do we want to
> collect it together?  Typically, you gather all the information about an
> application into the manual when there is one.

We are using the wiki only to collect the raw content that will be the basis for the manual, and also to provide early instructions for people who might want to try the build functionality of Toaster before it is "officially" released in April 2015. 

Once the manual is in place, we can get rid of the wiki pages.

> 
> Scott
Comment 7 Scott Rifenbark 2014-11-12 15:24:20 UTC
Perfect... thanks Belen.
Comment 8 Scott Rifenbark 2014-11-13 17:48:11 UTC
Setting to 1.8 M4.
Comment 9 Scott Rifenbark 2014-11-13 17:50:41 UTC
Hi, 

I could use some high-level organizational and content feedback for the book. See http://www.yoctoproject.org/docs/1.8/toaster-manual/toaster-manual.html#toaster-manual-dev-notes for my initial coverage and chapter break-outs. 

Scott
Comment 10 Scott Rifenbark 2015-02-04 02:31:45 UTC
Hi, 

I have a new version for review at http://www.yoctoproject.org/docs/1.8/toaster-manual/toaster-manual.html.  It needs much work but I want to start the review process so we can begin iterating on this new book. 

Please look it over and give me any type of feedback.  

Thanks, 
Scott
Comment 11 Scott Rifenbark 2015-02-13 15:47:54 UTC
Hi, 

A second draft of the Toaster User Manual is available at http://www.yoctoproject.org/docs/1.8/toaster-manual/toaster-manual.html.  Please review it and provide me with feedback and missing content.

Thanks, 
Scott
Comment 12 Scott Rifenbark 2015-02-20 19:32:50 UTC
A new version of the manual is available for review at http://www.yoctoproject.org/docs/1.8/toaster-manual/toaster-manual.html.

This version is a cluster (in my opinion) regarding the set up.  I have taken Alexandru's PPT information and attempted to meld it into what was there.  The result is notably incorrect I am sure.  I need some serious review here on this version.  Please look at it and give me some feedback. 

Thanks, 
Scott
Comment 13 Scott Rifenbark 2015-03-30 22:00:08 UTC
Hi, 

We got a couple more days is all to get changes into this manual.  Send me changes by end of day April 1.  I can get those in for 1.8.

Scott
Comment 14 Scott Rifenbark 2015-04-06 17:53:16 UTC
Hi, 

Marking RESOLVED.  1.8 version is complete.

Scott
Comment 15 Valentin Hangan 2015-04-16 14:33:35 UTC
Verified.