Dancer2 Documentation Grant Final Report
Fri, 21-Feb-2025 by
Saif Ahmed
edit post
< submitted In November, [Jason Crome](https://cromedome.net/) ([CROMEDOME](https://metacpan.org/author/CROMEDOME) on CPAN Authors) has submitted his final report for his project documenting [Dancer2](https://metacpan.org/dist/Dancer2). A comprehensive documentation with tutorials and a cookbook that should enable easy engagement with this very useful framework, this is presented in a professional yet accessible way. His monthly reports and his final post follow below:-
<hr>
### Dancer2 Documentation Grant Report for November 2024
_Work Accomplished_:
* The Cookbook is completed.
* I posted the Cookbook along with the completed Manual to the Dancer2 mailing list for public review. The community might spot room for improvement or correction opportunities.
* The Deployment guide is complete.
* The Keyword guide is nearly complete. Once complete, it will also be posted to the community along with the Deployment guide.
* Some of the prep work for the Tutorial has been completed.
_Up Next_:
* Complete the Keyword guide
* Start the Tutorial by December 16th.
_Stated Goals_:
As we know by now, the original timeline has shifted (due unexpected natural disasters, holidays and vacations, and personal obligations), but we are moving along very nicely with a clear progress and timeline for the rest of the work.
Per the roadmap we provided last month, here's our remaining list of tasks:
* Finalize the Cookbook
* Review and revise the Deployment Guide
* Review and revise the Keyword Guide
* Publish the above for public review
* Write the tutorial
* Process feedback from public review and incorporate relevant changes
Work on the grant is expected to complete by the end of December.
You can follow ongoing progress at https://github.com/PerlDancer/Dancer2/tree/docs/doc-rewrite-grant
### Dancer2 Documentation Grant Report, December 2024
I intended to wrap up in December but additional work came up. Keeping this in mind, I still made good progress:
Keyword Guide Mostly Complete
The revised guide is a fresh and accurate portrayal of modern Dancer2. However, that meant that some keywords were omitted. An existing test that makes sure we document all keywords implemented by Dancer2 (even those discouraged or outdated usage) caught those omitted keywords. Most of those keywords have been documented now.
_Tutorial_
A lot of the tutorial is written. I reached a point where I wasn't happy with how it was turning out, and so I backtracked and rewrote some parts that were previously completed. This set things back a bit, but the tutorial is going to turn out better for it. The core of the tutorial is pretty well finished; most of the outstanding work involves showing how to add authentication to a Dancer2 application.
I'm hoping to have good news by the end of next week. I have been in contact with Sawyer throughout this time to align on how to address everything to a satisfactory grant completion.
### Dancer2 Documentation Grant Report, January 2025
Great news! This grant is just about wrapped up. I have posted the completed work for public review. The review phase will wrap up on Feb. 17; if I receive enough actionable feedback, I may extend this window.
The few remaining items are:
* While public review happens, tidy up the git commit history
* Address public review feedback
* (Estimated) Submit the grant as completed on 2025-02-17
At the conclusion of the public feedback phase, Sawyer and I think the new Dancer2 manual will have met the goals stated in the grant proposal, payment can be sent, and the grant concluded.
Let me know if you have questions or concerns. Thanks!
### [Dancer2 Documentation Grant](https://github.com/PerlDancer/Dancer2/pull/1721) completed
Highlights include:
* A new Dancer2::Manual (the core of the manual)
* New tutorial and example application
* New Cookbook and Deployment Guide
* New quickstart guide
* Revised keyword guide (in lieu of a revised migration guide)
* Reorganized documentation to make help easier to find
Upon approval from my grant manager, Sawyer, I kindly request payment of the remaining grant award ($1,400 USD).
]]>
Category:
(none)
Comments (0)
