Re: [Webhob] Web Hob documentation?

["Barros Pena, Belen" <belen.barros.pena@intel.com>]

On 13/06/2013 13:11, "Rifenbark, Scott M" <scott.m.rifenbark@intel.com>
wrote:

>Right now we have a small section in the dev-manual that is called "Image
>Development Using Hob".  It introduces Hob as a method to develop images,
>states it is UI-driven, and tells how you can set it up and invoke it.
>It references our Hob page on the website.  The section also highlights
>and lists the main functions that you can do using Hob. So I think what
>you are saying needs to be in the YP docs already exists.

I might be reading this wrong (sorry if that's the case), but Hob and Web
Hob are different tools. Hob is a building tool and it's a native
application. The first version of Web Hob, which is what we are referring
to here, is more a build analysis tool, and it's a web application (it
runs on your browser). So it looks like we'll need:

* A new section in the YP manuals (not sure which one of them) for Web Hob
* A new wiki page for Web Hob
* A new webpage on the website for Web hob

According to Richard's list, the above should cover:

* basic information about the fact the UI exists,
* how to start it, 
* what the capabilities are,
* the limitations
* some indication of future plans (high level).

If we add any developer oriented docs, those would go in the bitbake
manual.

Would people agree with this?


Belen

>
>Scott
>
>>-----Original Message-----
>>From: Richard Purdie [mailto:richard.purdie@linuxfoundation.org]
>>Sent: Thursday, June 13, 2013 4:38 AM
>>To: Bill Traynor
>>Cc: Barros Pena, Belen; Paul Eggleton; Rifenbark, Scott M;
>>webhob@yoctoproject.org
>>Subject: Re: [Webhob] Web Hob documentation?
>>
>>On Thu, 2013-06-13 at 07:23 -0400, Bill Traynor wrote:
>>> On Thu, Jun 13, 2013 at 6:59 AM, Barros Pena, Belen
>>> <belen.barros.pena@intel.com> wrote:
>>>         I am not even sure if need to produce Web Hob documentation
>>>         for the 1.5
>>>         release, but I thought I'd bring it up just in case. Maybe
>>>         something
>>>         lightweight, like the Hob manual page on the website, might be
>>>         enough.
>>>
>>>         Let me know what you think.
>>>
>>> Is Webhob to be a part of BitBake proper?  I see that Webhob patches
>>> are hitting the bitbake-devel list.  If the answer is yes, that Webhob
>>> is to be a part of BitBake and it's source code live within the
>>> BitBake source tree, then my feeling is that it's documentation should
>>> be part of the BitBake manual.
>>
>>I think the answer is "it depends". I think for 1.5 we will need some
>>basic information about the fact the UI exists,  how to start it, what
>>the capabilities are, the limitations and some indication of future
>>plans (high level). This would probably be fine in the YP manuals and/or
>>on the wiki. If we do add any developer oriented docs such as how to
>>extend/customise it, those would probably be best in the bitbake manual.
>>
>>Cheers,
>>
>>Richard
>>
>>
>

---------------------------------------------------------------------
Intel Corporation (UK) Limited
Registered No. 1134945 (England)
Registered Office: Pipers Way, Swindon SN3 1RJ
VAT No: 860 2173 47

This e-mail and any attachments may contain confidential material for
the sole use of the intended recipient(s). Any review or distribution
by others is strictly prohibited. If you are not the intended
recipient, please contact the sender and delete all copies.