Jifty Book
==========

Introduction to the Book Idea 

by Andrew Sterling Hanenkamp.
(a.k.a. sterling in Subversion)
(a.k.a. zostay in IRC)

Last Updated November 21, 2007 around 1 AM CST

HISTORY

At OSCON 2007, I just happened to be talking with Jesse and made the half-joking
remark that Jifty really needs a book. Jesse took the idea quite seriously and
we've been corresponding on the idea since. He and I have worked out an outline
and some basic conventions for the book so far.

As of this writing, I am just starting the writing portion. I haven't fully
settled on it, but I plan to use Spensive which Jesse committed earlier today as
the tutorial application.

I hope to have the rest of the outline (as far as I've finished it) in the
repository as I have time.

CONTRIBUTING

I've taken on the role of primary writer for the book, but additional
contributions are very welcome. As with the Jifty framework itself, be sure to
add yourself to the AUTHORS file first so that we know to attribute part of the
text to you should it become published. I cannot promise any royalties or fame
or glory in exchange for your contributions, but you will be helping the Jifty
community.

If you're just correcting typos or errors or fleshing out a section, feel free
to commit your changes however you like. If you want to make structural changes
to the chapter outlines themselves, I'd appreciate it if we can discuss it on
the mailing list or in IRC first, but I won't be upset if you just commit the
change. I subscribe to the "Be bold" philosophy of Wikipedia, so I'd rather have
a problematic contribution has to be rolled back than miss out on something
valuable. So, be bold.

LICENSE

Be aware that all contributions are licensed under the the Creative Commons
Attribute-Share Alike 3.0 United States License.

  http://creativecommons.org/licenses/by-sa/3.0/us/

Be sure to understand that license before using this text, but know that you can
use the text of this book for your own purposes according to the terms of this
license.

FORMATTING

I've chosen to use the PseudoPod format for the book, which is an extension of
regular Plain Old Documentation. If you don't know how to use PseudoPod you can
either just pretend it's POD or read the tutorial:

  http://search.cpan.org/~arandal/Pod-PseudoPod-0.13/lib/Pod/PseudoPod/Tutorial.pod

TESTING

If you do make any changes, I'd appreciate it if you ran:

  perl Makefile.PL
  make test

which will test for errors in your PseudoPod. Please correct your errors before
committing, if you can.

CONTACTING ME

If you want to discuss something related to this, you can get me via zostay on
IRC or you can talk to obra (Jesse). You can post to the Jifty mailing list. Or
if you want to email me directly, just use hanenkamp@cpan.org.