Bug 6286

Summary: Autobuilder developers manual
Product: [Infrastructure] AutoBuilder Reporter: Beth Flanagan <elizabeth.flanagan>
Component: autobuilderAssignee: Beth Flanagan <elizabeth.flanagan>
Status: VERIFIED FIXED QA Contact: Bogdan Alexandru Voiculescu <bogdanx.a.voiculescu>
Severity: enhancement    
Priority: Medium CC: bluelightning, bogdanx.a.voiculescu, elizabeth.flanagan, infras.ab.watcher, Infras.watcher, jessica.zhang
Version: unspecified   
Target Milestone: 2.0   
Hardware: x86   
OS: Multiple   
Whiteboard:
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Yes (doc changes required)

Description Beth Flanagan 2014-05-07 22:21:31 UTC 
We need a developers manual that tells folks:

1. How to set up an autobuilder.
2. How to create their own configs
3. How to hack the autobuilder to create new buildsteps
4. How to contribute
Comment 1 Beth Flanagan 2014-05-12 22:43:36 UTC 
Lynn,

Work with me on this. As you'll have an outside view of what this takes, I think you'd have a bit of a better view than I.
Comment 2 Lynn Cyrin 2014-05-12 22:53:01 UTC 
Gotcha, creating guides / docs is one of my favorite tasks for new people.
Comment 3 Beth Flanagan 2014-11-20 16:13:55 UTC 
We currently have this committed to the ab repo, still needs some additional info and a once over by srifenbark.
Comment 4 Scott Rifenbark 2014-11-21 13:13:22 UTC 
Beth, 

Can you tell me where to find this documentation?  I don't know how to get to the ab repo.  Once found, I will give it an edit.

Thanks, 
Scott
Comment 5 Beth Flanagan 2014-12-09 01:16:45 UTC 
http://git.yoctoproject.org/cgit/cgit.cgi/yocto-autobuilder/tree/docs/YoctoAutobuilderDevelopersDocument.html

Scott,

if you could git clone the AB repo (git clone git://git.yoctoproject.org/yocto-autobuilder) and give this a quick read for clarity (it still is missing some stuff, but that's coming to a close), I'd appreciate it.
Comment 6 Scott Rifenbark 2014-12-09 12:54:07 UTC 
Beth, 

So I cloned this and gave it a fast read.  Outside of some formatting and a few typo things it seems okay.  I do have some questions...

 1. Where is the source for this manual?  Is it simply a hand-created 
    HTML document?

 2. Do you want better formatting?  Or, is what we have adequate for the 
    particular audience?

 3. There are some missing items exposed through notes within the text.
    Are these going to be supplied later?

 4. How would one give feedback for the HTML document?  Is there a way 
    to submit a patch against the manual?

Scott
Comment 7 Beth Flanagan 2015-09-30 13:17:16 UTC 
I'm going to mark this as Resolved. We have a slightly incomplete developers manual that exists and will need continued updating, but at this point, it makes no sense to have a continuous bug open for it.