Alexandr Ciornii ('chorny' on IRC and PAUSE).
[hidden email] (backup) [hidden email]
- Amount Requested:
Many CPAN modules have good documentation, many have bad documentation. But there is no such thing as enough documentation. There are many good reviews, examples, descriptions outside CPAN. I propose to collect them and cataloguize.
I want to make a site with links to reviews of CPAN modules. In general this site should be community-moderated, community-edited and allow users adding links to do minimal work first and enhance later, i.e. use this site as a bookmarking service.
Benefits to the Perl Community
Simplify learning CPAN modules for novices and mature users - no need to scan google search results, and be able to see is it worth reading review or not, by opinion of others.
Ability to store list of useful links and share it with others.
Possibility of integrating list of links into author own page.
A ready code of site to copy and use for similar purposes.
Support for OpenID/Bitcard in CGI::Application.
Code of web app (under open license)
CPAN module to support for OpenID/Bitcard in CGI::Application.
After release I will maintain and enhance code and site further.
I plan to develop it using CGI::Application. I will need to develop CGI::Application::Plugin::Authentication plugin for OpenID/Bitcard.
Users will be able to vote up/down for link, report spam or dupe link, comment. Every link will have title and description (only one from them will be mandatory), language, date (original), tags, list of modules described in review. After adding link, some info will be fetched automatically, so user will need to edit it.
No users registration at all, OpenID/Bitcard only.
- To display list of links for a module (sorted by popularity).
- To display number of links for a module.
They would be customizable, by language of links or language list can be received from HTTP headers. Also JSON output should be available.
Site would be able to get list of links from RSS feeds by tag (I propose "cpanreview", but this will be discussed with Perl community). Also tags like "cpanreview-Module::Name" or "cpanreview-Dist-Name" would add association with module. Unassociated links would be displayed separately on special page for anyone who would like to review some links.
It would be possible for any user with sufficient number of upvotes (for ex. 2) to modify title/description/module_list of link. Number of votes should be customizable for every operation.
Github will be used for hosting code.
- OpenID/Bitcard plugin
- Adding links
- Automating fetching data about link added by user (title, modules mentioned)
- Comment system
- Community editing
- RSS fetching
- Refactoring based on opinion of Perl community on real version.
I will begin work immediately, with 10-15 hours a week. First version with reduced capabilities should be available in 1.5 month, full version in 3 month.
I'm Perl programmer from Moldova (Europe). I've working in Perl from 2000, joined Strawberry Perl project in 2006. I'm active memeber of Perl community, maintain 18 modules on CPAN and several more are planned for release next month. I have big number of patches for Perl modules, including CGI::Application plugins, ExtUtils::MakeMaker, Module::Install.