Sugar on a Stick Docs using Publican

[Paul W. Frields]

On Thu, Feb 18, 2010 at 11:10:38PM +0100, Sebastian Dziallas wrote:
> Paul W. Frields wrote:
> > On Wed, Feb 17, 2010 at 04:57:49PM -0700, Eliot Smith wrote:
> >> On 02/17/2010 12:59 PM, Paul W. Frields wrote:
> >>> On Wed, Feb 17, 2010 at 04:56:13PM +0100, Sebastian Dziallas wrote:
> >>>
> >>>> Hi all,
> >>>>
> >>>> as some of you may have heard, Sugar on a Stick [1] is going to become a
> >>>> Fedora Spin for F13. I've had some spare time last weekend and took the
> >>>> chance to create this: http://people.sugarlabs.org/sdz/
> >>>>
> >>>> (It's far from being complete, but I finally wanted to give Publican a
> >>>> try. It rocks.)
> >>>>
> >>>> If anybody has random comments or would be interested in helping out,
> >>>> please holler... :)
> >>>>
> >>> Looks like a great effort Sebastian!
> >>>
> >>> Eliot introduced himself the other day on our list -- Eliot, we use
> >>> Publican as a tool for creating guides like the one Sebastian linked
> >>> above.  This is a great opportunity to learn how to use the tool by
> >>> looking at (and maybe contributing to) a very short and simple
> >>> document.  Are you game?
> >>>
> >> Yes, I'm game.
> >
> > (reformatted reply to keep the thread easy to read... refer to
> > https://fedoraproject.org/wiki/Mailing_list_guidelines#top-posting for
> > more info)
> >
> >
> > Awesome!  Sebastian, looks like you now have a Docs contributor to
> > help you with your Sugar on a Stick documentation.  What I'd suggest
> > is that the two of you use a combination of:
> >
> > (1) This list
> > (2) IRC Freenode, #fedora-docs
> >
> > ...to plan out how you want that guide to grow.  Sebastian probably
> > already has ideas for what needs to be expanded, it's just a matter of
> > writing it down somewhere and then working on the doc
> > collaboratively.  By using this email list, you might be able to
> > gather even more people to help.  Snowball effect, woo!
> >
> > Also... if both of you are on this list now, I'll stop sending cc's to
> > you personally, sorry for the noise.
> 
> Paul, thanks a lot for this! Both options sound fine to me. I guess I'd 
> better add #fedora-docs to XChat's auto-login, heh.
> 
> One thing I was wondering about is what it'd take to get this at some 
> point as an official document - since Sugar on a Stick will be an 
> official spin, too...

Well, in terms of making things easy for users, the best place for
these types of documents to live is right alongside the spin on its
own site.  In other words, you don't want to send users away somewhere
else (like docs.fp.o) when you can give them the download and the
guide together in one place.

Besides that consideration, though, there's the completely ugly truth
that the Docs publishing chain right now is a horrible nest of snakes
that you don't want to bother with.  In the future, assuming some Docs
contributors get involved with the effort, we'll be able to get all
guides available through a snazzy new (and simpler) interface on
Fedora Insight.  But until that happens I would recommend the approach
of simply having a PDF available on your spins site.  Thank goodness
Publican makes that part of publishing pretty simple.

-- 
Paul W. Frields                                http://paul.frields.org/
  gpg fingerprint: 3DA6 A0AC 6D58 FEC4 0233  5906 ACDB C937 BD11 3717
  http://redhat.com/   -  -  -  -   http://pfrields.fedorapeople.org/
          Where open source multiplies: http://opensource.com