[Toaster] [RFC] Toaster manual - 2.0 release

[Scott Rifenbark]

On Fri, Oct 2, 2015 at 7:52 AM, Barros Pena, Belen <
belen.barros.pena at intel.com> wrote:

>
>
> On 30/09/2015 17:19, "Scott Rifenbark" <srifenbark at gmail.com> wrote:
>
> >
> >
> >On Wed, Sep 30, 2015 at 7:58 AM, Barros Pena, Belen
> ><belen.barros.pena at intel.com> wrote:
> >
> >Right, take 2. This is a list of the things that seem to me we'll need to
> >change in the Toaster manual for 2.0:
> >
> >* Do we remove the section about the 2 modes? Ed: do you think you will
> >have patches on time?
> >
> >* If the above is yes, remove all other references to 'modes' scattered
> >across the manual
> >
> >* If the above is yes, Belén will need to provide a new video showing the
> >new single mode
> >
> >* Do we want to keep the explanation of the installation options?
> >
> >
> http://www.yoctoproject.org/docs/1.8/toaster-manual/toaster-manual.html#to
> >a
> >ster-installation-options
> >
> >* Change section 2.2.1 Optionally Setting Up a Python Virtual Environment.
> >This should now be presented as the preferred way of setting up Toaster
> >
> >
> >
> >
> >I re-worded this 2.2.1 section to so that it is not optional.  I worded
> >before as "strongly suggested", which you could argue as already being
> >suggested as the preferred method.  The only question I have is if it is
> >still optional and simply strongly preferred,
> > my changes have pretty much indicated that the user needs to do it now.
> >Let me know if there is an issue with this.  See
> >
> >
> http://www.yoctoproject.org/docs/2.0/toaster-manual/toaster-manual.html#to
> >aster-virtual-environment
> ><
> http://www.yoctoproject.org/docs/2.0/toaster-manual/toaster-manual.html#t
> >oaster-virtual-environment>.
>
> I think this works. What we could do is adding a second note to the
> section, after the 'initialise the venv' one, explaining that creating a
> virtual environment is not absolutely necessarily, but highly recommended.
>
> Brian: if you rather do something different, let us know.
>

I added a note at the top of that section as it is better placed there.  It
basically "highly recommends" creating the virtual environment.  See at
http://www.yoctoproject.org/docs/2.0/toaster-manual/toaster-manual.html#toaster-virtual-environment


>
> >
> >
> >
> >
> >* Remove section 2.2.3 Install daemon. The dependency on daemon has been
> >removed
> >
> >
> >
> >
> >Not sure which version of the Toaster Manual you were looking at when you
> >noticed the 2.2.3 section.  The latest version for 2.0 already had this
> >section commented out so it does not appear in the manual.
>
> I guess I was looking at the 1.8 one. Sorry.
>
> >
> >
> >
> >
> >
> >* What do we want to do with chapter 3? Should we explain how to set up
> >Toaster locally first, then how to set it up as a hosted service? Brian:
> >you had some ideas about this, I think.
> >
> >* I believe there have been some changes in the build delete command, but
> >can't find anything in Bugzilla. Brian: was it you who make those changes
> >by any chance?
> >
> >* Update preconfigured releases and toasterconf.json file snippets to show
> >the new release list
> >
> >
> >
> >
> >See
> >
> http://www.yoctoproject.org/docs/2.0/toaster-manual/toaster-manual.html#ed
> >it-the-configuration-file
> ><
> http://www.yoctoproject.org/docs/2.0/toaster-manual/toaster-manual.html#e
> >dit-the-configuration-file> and let me know if the otasterconf.json file
> >example I have in there will be correct.  I changed it so master, fido,
> >and jethro are in there.  I dropped
> > dizzy.  I don't know if the exact order will match what you guys do to
> >the actual file.
>
> You can now copy/paste from here
>
> http://git.yoctoproject.org/cgit/cgit.cgi/poky-contrib/tree/meta-yocto/conf
> /toasterconf.json?h=bavery/toaster/jethro_update_meta-yocto_8428
>
> Just mind the typo on line 98 where it says 'jethr0' instead of 'jethro' :)
>

Got this handled.


>
> Cheers
>
> Belén
>
> >
> >
> >
> >
> >If I am missing anything, please add to the list.
> >
> >Thanks!
> >
> >Belén
> >
> >
> >
> >On 17/09/2015 15:44, "toaster-bounces at yoctoproject.org on behalf of
> Barros
> >Pena, Belen" <toaster-bounces at yoctoproject.org on behalf of
> >belen.barros.pena at intel.com> wrote:
> >
> >>The 2.0 release is getting close and we need to look at the changes
> >>required to the Toaster manual. We need to get an idea of those for the
> >>project tech writer, to see if he can fit this work in (otherwise we will
> >>have to do it ourselves).
> >>
> >>The 1.8 Toaster manual is here
> >>
> >>
> http://www.yoctoproject.org/docs/1.8/toaster-manual/toaster-manual.html#t
> >>o
> >>a
> >>ster-manual-dev-notes
> >>
> >>We discussed changing the structure of the existing content to give more
> >>emphasis to a single way of setting up and running Toaster. Do we still
> >>want to do this?
> >>
> >>If the work for removing the 2 modes makes it to the release, that will
> >>also require significant changes to the manual content. Is it likely the
> >>modes work will be merged?
> >>
> >>
> >>Are there any other changes needed to the manual?
> >>
> >>Thanks!
> >>
> >>Belén
> >>
> >>
> >>
> >>
> >>
> >>
> >>--
> >>_______________________________________________
> >>toaster mailing list
> >>toaster at yoctoproject.org
> >>https://lists.yoctoproject.org/listinfo/toaster
> >
> >
> >
> >
> >
> >
> >
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.yoctoproject.org/pipermail/toaster/attachments/20151002/bdd3930d/attachment.html>