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

[email protected] (Kent Fredric) Thu, 7 May 2015 06:42:33 +1200
Newsgroups perl.cpan.workers,perl.qa
Message-ID <CAATnKFBzr4jRk1M+HaZc=CXKAAh0Q4xprVBGDs6cfk1SxCkX=g@mail.gmail.com>
--089e013a032e7fa93705156e282a
Content-Type: text/plain; charset=UTF-8

On 7 May 2015 at 02:46, H.Merijn Brand <[email protected]> wrote:

> How much I admire this effort (+1000 as you say from me as well), I
> think a structured HTML doc that people can download and read or PDF
> with index will reach a wider audience.
>


Generally, with HTML, if I want to read HTML, I need a browser. Having the
HTML on disk there just serves as an annoyance factor while I tell my OS to
tell my browser to open the file. ( To contrast with "perldoc Foo" or
<!mcpan foo> in my search bar, needing to locate an ABSPATH first is a bit
annoying )

Generally that implies I have internet, and so a website ( such as metacpan
) is an ideal Go-To.

I would not be opposed to HTML and PDF renditions of said policies being
available, the PDF is of course more likely to be amenable for people who
just want to read it on their phone/kindle/whatever.

And you could, perhaps, periodically aggregate the Policy::<> stuff docs
published to CPAN and format them to a single doc and potentially ship that
with perl .... but I find it hard to imagine P5P wants to elevate
"toolchain + CPAN policies" to "part of perl itself" level.

I find it hard to imagine any of this would be integrated with perl itself,
in any way, no matter how it was formatted, because a large amount of the
concerns presented don't pertain to "Perl itself", but to the CPAN
Ecosystem in general.

-- 
Kent

*KENTNL* - https://metacpan.org/author/KENTNL

--089e013a032e7fa93705156e282a
Content-Type: text/html; charset=UTF-8
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr"><div class=3D"gmail_extra"><br><div class=3D"gmail_quote">=
On 7 May 2015 at 02:46, H.Merijn Brand <span dir=3D"ltr">&lt;<a href=3D"mai=
lto:[email protected]" target=3D"_blank">[email protected]</a>&gt;</spa=
n> wrote:<br><blockquote class=3D"gmail_quote" style=3D"margin:0 0 0 .8ex;b=
order-left:1px #ccc solid;padding-left:1ex"><div id=3D":813" class=3D"a3s" =
style=3D"overflow:hidden">How much I admire this effort (+1000 as you say f=
rom me as well), I<br>
think a structured HTML doc that people can download and read or PDF<br>
with index will reach a wider audience.</div></blockquote></div><br><br></d=
iv><div class=3D"gmail_extra">Generally, with HTML, if I want to read HTML,=
 I need a browser. Having the HTML on disk there just serves as an annoyanc=
e factor while I tell my OS to tell my browser to open the file. ( To contr=
ast with &quot;perldoc Foo&quot; or &lt;!mcpan foo&gt; in my search bar, ne=
eding to locate an ABSPATH first is a bit annoying )<br><br></div><div clas=
s=3D"gmail_extra">Generally that implies I have internet, and so a website =
( such as metacpan ) is an ideal Go-To.<br><br></div><div class=3D"gmail_ex=
tra">I would not be opposed to HTML and PDF renditions of said policies bei=
ng available, the PDF is of course more likely to be amenable for people wh=
o just want to read it on their phone/kindle/whatever.<br><br></div><div cl=
ass=3D"gmail_extra">And you could, perhaps, periodically aggregate the Poli=
cy::&lt;&gt; stuff docs published to CPAN and format them to a single doc a=
nd potentially ship that with perl .... but I find it hard to imagine P5P w=
ants to elevate &quot;toolchain + CPAN policies&quot; to &quot;part of perl=
 itself&quot; level.<br><br></div><div class=3D"gmail_extra">I find it hard=
 to imagine any of this would be integrated with perl itself, in any way, n=
o matter how it was formatted, because a large amount of the concerns prese=
nted don&#39;t pertain to &quot;Perl itself&quot;, but to the CPAN Ecosyste=
m in general.<br></div><div class=3D"gmail_extra"><br>-- <br><div class=3D"=
gmail_signature"><div dir=3D"ltr"><div>Kent<font size=3D"1"><b> <br><br></b=
></font></div><div><span style=3D"color:rgb(204,204,204)"><font size=3D"1">=
<b>KENTNL</b> - <a href=3D"https://metacpan.org/author/KENTNL" target=3D"_b=
lank">https://metacpan.org/author/KENTNL</a></font></span><br></div><div><b=
r></div></div></div>
</div></div>

--089e013a032e7fa93705156e282a--