develooper Front page | perl.cpan.workers | Postings from May 2015

Re: Documenting best practices and the state of ToolChain guidelines using CPAN and POD

Thread Previous | Thread Next
Neil Bowers
May 6, 2015 21:31
Re: Documenting best practices and the state of ToolChain guidelines using CPAN and POD
Message ID:
> In that vein, we need some sort of Canon set of documentations, written and maintained by toolchain themselves, articulating how things /should/ be done as far as toolchain are concerned, without any sort of requirement that people adhere to it, unless they want to make toolchain happy.


> As such, I propose a very rudimentary idea:
> Toolchain
> This is the top namespace 
> Toolchain::Standards

Please please please, let’s not put this on CPAN. There are enough abuses of CPAN already. It’s a comprehensive archive of Perl, not everything in any way related to Perl. Plus I wouldn’t want to constrain this sort of documentation to pod, and how it’s presented on MetaCPAN / <>, which is what we’d effectively be talking about.

If there were a canonical source of information related to toolchain etc, then plenty of things on CPAN would link to it in their SEE ALSO sections, but it really doesn’t have to be *on* CPAN.

I’m no great fan of wikis, but I often thought it surprising that there isn’t a centralised wiki for Perl knowledge, a Perlipedia, if you will. It doesn’t have to be a wiki. It could be done via a github repo / github pages (yes, I did note your comment about markdown, but markdown is preferable to pod rendered via MetaCPAN, IMHO :-) The advantage of a wiki is that it makes it very easy to contribute.

There’s one domain that’s woefully under-used where this could live:

This isn’t a fully thought-out response, but I wanted to (a) offer support for the concept, and (b) plead that it not be done via CPAN.


Thread Previous | Thread Next Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at | Group listing | About