Perl 6 Pod Rendering

[zoffixznet]

Hi,

We'd like to have Perl 6 Pod documents rendered on GitHub, just as Perl 5 Pod documents get rendered.

We can do the legwork and add the PR to this repo, but my question is what would be involved in having the P6Pod to HTML converter installed. It'll basically involve installing a perl 6 compiler and Pod::To::HTML module. We also have a Docker image if that's a better solution.

Let us know how we can proceed with having GitHub display Perl 6 Pod.

Thanks.

[zoffixznet]

Hi, any suggestions?

[gjtorikian]

Hi @zoffixznet ! Sorry for the late reply.

In terms of installing the Perl6 software and modules, we'll handle that on our end. It may take us some time to do this, as any new packages introduced are vetted by our security and ops teams.

You're certainly more than welcome to perform a PR with tests, and update the .travis.yml file so that our CI test suite verifies that Perl6 documentation is being generated.

cc @github/workflow

[tbrowder]

When you say "PR with tests" to what repo do you refer? (Or do you mean test any repo using a pod6 document?)

[gjtorikian]

Ah! To clarify: you should add the Ruby glue necessary for this gem to properly render Perl6 POD files.

By tests, I mean that you should also add a markup file and an expected HTML rendered file to ensure that the input produces consistent output. We have a folder full of these sorts of tests: https://github.com/github/markup/tree/master/test/markups

Does that clarify it?

[kivikakk]

Closing this as stale (2y old); if you can get a PR together, we can keep moving on this.

[tbrowder]

Thanks. Someone will tackle this eventually.