<div dir="ltr"><div><div><div><div>Hi everyone,<br><br></div>Thank you all, it could not have been done without Sawyer's help and guidance.<br></div>I would love to have your feedback on the work that has been done, and any suggestions for further improvement in the documentation.<br><br></div>Regards,<br></div>Snigdha<br></div><div class="gmail_extra"><br><div class="gmail_quote">On Sat, Feb 7, 2015 at 4:33 AM, Andrew Solomon <span dir="ltr"><<a href="mailto:andrew@geekuni.com" target="_blank">andrew@geekuni.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">I can't wait to see it on the big (metacpan) screen! :)<br>
<div class="HOEnZb"><div class="h5"><br>
On Fri, Feb 6, 2015 at 5:01 PM, Juan José 'Peco' San Martín<br>
<<a href="mailto:jsanmartin@gmail.com">jsanmartin@gmail.com</a>> wrote:<br>
> Clap clap clap!!!<br>
><br>
> Great news!<br>
><br>
> Peco<br>
><br>
> 2015-02-06 15:56 GMT+01:00 Sawyer X <<a href="mailto:xsawyerx@gmail.com">xsawyerx@gmail.com</a>>:<br>
>><br>
>> Hi everyone,<br>
>><br>
>> I had a few conferences, lots of work, and then, of course, I was under<br>
>> the weather, so not much was heard from me in a while. Consider yourselves<br>
>> lucky. :)<br>
>><br>
>> However, having regained enough composure to finally merge the massive PR<br>
>> Snigdha Dagar has submitted as part of her work on overhauling the<br>
>> documentation, I'd like to share it with you, because it's too cool to keep<br>
>> to myself.<br>
>><br>
>> First, you can view the entire thing here:<br>
>><br>
>> <a href="https://github.com/PerlDancer/Dancer2/commit/6eaa6a8136ad26c76a40c3aef49d86310e4474e1" target="_blank">https://github.com/PerlDancer/Dancer2/commit/6eaa6a8136ad26c76a40c3aef49d86310e4474e1</a><br>
>><br>
>> But you probably don't want to. Why? Here's the summary:<br>
>> 6 files changed, 2659 insertions(+), 1236 deletions(-).<br>
>><br>
>> Why? Well... let me tell you what she did. She completely restructured the<br>
>> Manual and Cookbook. This included deciding what should go where, make it<br>
>> reachable from Dancer2.pm (what's rendered when you open up Dancer2 in<br>
>> MetaCPAN or perldoc), and structure it within those documents in a coherent<br>
>> manner.<br>
>><br>
>> The Manual now covers:<br>
>> * Installation<br>
>> * Bootstrapping<br>
>> * How to use Dancer2, including:<br>
>>   - The HTTP methods (including multi-methods)<br>
>>   - All route definitions<br>
>>   - Prefixes<br>
>>   - Hooks<br>
>>   - Handlers<br>
>>   - Errors<br>
>>   - Sessions<br>
>>   - Templates<br>
>>   - Static files<br>
>>   - File uploads<br>
>>   - Configuration<br>
>>   - Logging<br>
>> * How to test Dancer2<br>
>> * How to package Dancer2, currently covering:<br>
>>   - Carton<br>
>>   - FatPacker<br>
>>   (but more will be added)<br>
>> * How to add middlewares<br>
>> * Plugins<br>
>> And of course,<br>
>> * DSL keyword index<br>
>><br>
>> The Manual is now a proper Manual, explaining how Dancer should be used,<br>
>> which we could continue to expand so it covers explanations on any and all<br>
>> keywords as part of a guide you can read. You will still have the DSL<br>
>> keywords (which many of us jump for when we want to find a keyword quickly)<br>
>> as well, which we will slowly be using to point to the parts in the Manual<br>
>> which cover the keyword's usage.<br>
>><br>
>> The Cookbook now covers tricks and hints:<br>
>> * Splitting your application with prefix<br>
>> * Using auto_page (AutoPage itself covered in the Manual - here is only a<br>
>> tip to use it)<br>
>> * Delivering custom error pages<br>
>> * Using DBIx::Class<br>
>> * Authentication<br>
>> * Example for a REST application<br>
>> * Recommendations on serializers<br>
>> * Turning off warnings (under "Non-standard" :)<br>
>> * etc.<br>
>><br>
>> If there's a tip you give others, or a pattern you found useful, this is<br>
>> where you could submit it so others could enjoy. It would fall under "cool<br>
>> stuff", rather than "the design of the framework". One describes the pieces<br>
>> and how they interact. The other all the cool stuff you could do with them.<br>
>><br>
>> The Deployment document (which existed in 1 and was merged into the<br>
>> Cookbook at 2 - not the right thing) is now its own separate document,<br>
>> includes everything in Dancer 1 and adds more:<br>
>> * Running as CGI or FastCGI<br>
>> * Running on Perl web servers<br>
>> * Using different service utilities (daemontools, Ubic, etc.)<br>
>> * Under a reverse proxy<br>
>> * From Apache or Lighttpd<br>
>><br>
>> This is where we gather the knowledge of everyone deploying Dancer2 in<br>
>> various environments to make sure we have clear and useful instructions for<br>
>> the next person who wants to follow the same deployment pattern, and to<br>
>> offer examples of how you could deploy your Dancer2 applications.<br>
>><br>
>> The main module, Dancer2, now links to all of these so they are easily<br>
>> accessible. The DSL keyword index, since it is useful, is linked separately<br>
>> of the Manual, so we could find it much more quickly. This is something that<br>
>> nagged me personally. I never remembered *where* it was documented, and now,<br>
>> even though it's the proper place, I don't have to remember. Perldoc Dancer2<br>
>> and it's there.<br>
>><br>
>> I'd like to thank Snigdha for all the work she's done on this. It was not<br>
>> easy and included a lot of research before she could even begin reading the<br>
>> Dancer documents, comparing the changes between 1 and 2, making decisions<br>
>> about the structure, and moving everything inch by inch. (There actually<br>
>> were a lot of commits, but I did squashed some commits together.)<br>
>><br>
>> Have a great day,<br>
>> S.<br>
>><br>
>> _______________________________________________<br>
>> dancer-users mailing list<br>
>> <a href="mailto:dancer-users@dancer.pm">dancer-users@dancer.pm</a><br>
>> <a href="http://lists.preshweb.co.uk/mailman/listinfo/dancer-users" target="_blank">http://lists.preshweb.co.uk/mailman/listinfo/dancer-users</a><br>
>><br>
><br>
><br>
> _______________________________________________<br>
> dancer-users mailing list<br>
> <a href="mailto:dancer-users@dancer.pm">dancer-users@dancer.pm</a><br>
> <a href="http://lists.preshweb.co.uk/mailman/listinfo/dancer-users" target="_blank">http://lists.preshweb.co.uk/mailman/listinfo/dancer-users</a><br>
><br>
<br>
<br>
<br>
</div></div><span class="HOEnZb"><font color="#888888">--<br>
Andrew Solomon<br>
<br>
Mentor@Geekuni <a href="http://geekuni.com/" target="_blank">http://geekuni.com/</a><br>
<a href="http://www.linkedin.com/in/asolomon" target="_blank">http://www.linkedin.com/in/asolomon</a><br>
</font></span><div class="HOEnZb"><div class="h5">_______________________________________________<br>
dancer-users mailing list<br>
<a href="mailto:dancer-users@dancer.pm">dancer-users@dancer.pm</a><br>
<a href="http://lists.preshweb.co.uk/mailman/listinfo/dancer-users" target="_blank">http://lists.preshweb.co.uk/mailman/listinfo/dancer-users</a><br>
</div></div></blockquote></div><br><br clear="all"><br>-- <br><div class="gmail_signature"><div dir="ltr">Snigdha Dagar<br>Electronics and Communication Engineering<br>IIIT Hyderabad</div></div>
</div>