Re: [Yesod] Re: Yesod book repo?
I've updated the text, I think it was too long before. A lot of the
caveats about not being ready can be removed, and users don't need to
know that I check the syntax highlighted code, it should be a safe
assumption that the code snippets are accurate.
On Thu, Sep 1, 2011 at 9:38 AM, Bjorn Buckwalter
> OK, It seems submitting book content patches/pull requests is a thing
> of the past then(?).
> Some comments then regarding http://www.yesodweb.com/book
> 1. It would be nice if this page also accepted comments like the
> others in the book, but since it is not I'm sending my comments here.
> 2. "If you have any suggestions, you can email me or simply send
> patches to the Yesod documentation site github repo." Maybe it could
> be clarified that the repo is only for infrastructure and not content?
> (And perhaps readers of the first page are unlikely to submit
> infrastructure changes anyway?) You could also mention the paragraph
> commenting system here.
> 3. "All syntax-highlighted code snippets are automatically tested
> against the most recent Yesod release (0.8.0) to ensure they are
> correct." – 0.8.0 is not the most recent release any more. Is the
> automated testing against 0.8 or 0.9 now, or not at all?
> On Sep 1, 10:46 am, Michael Snoyman <mich...@...> wrote:
>> snoyberg/yesoddocs is what actually gets used in practice. Greg
>> created the yesodweb/yesoddocs and does his hacking on it.
>> The actual book content is all stored in the database as DITA. Little
>> known secret: you can download it all here:http://www.yesodweb.com/show/map/1/download
>> As for how to turn that into something meaningful... DITA is an open
>> standard, similar to say DocBook. The industry I work in uses it a
>> lot, and for processing it uses something called the DITA-OT. The
>> DITA-OT is one of the most poorly written pieces of software I've ever
>> had the misfortune of using. I'm in the process of writing some
>> alternate processing code in Haskell. When that's ready, you could in
>> theory use that to convert the book into another format.
>> On Thu, Sep 1, 2011 at 3:04 AM, Bjorn Buckwalter
>> <bjorn.buckwal...@...> wrote:
>> > Hi All,
>> > Ishttp://github.com/snoyberg/yesoddocs/still the official repo for
>> > the book or should it behttp://github.com/yesodweb/yesoddocs/?
>> > Where is the actual book content? The repo seems to be all logic. The
>> > only trace of content I see is in the book-xml branch from Nov 2010.
>> > Thanks,
>> > Bjorn