Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds POD6, the markup language for Perl6, to the repo #1173

Merged
merged 21 commits into from
Dec 12, 2018
Merged

Conversation

JJ
Copy link
Contributor

@JJ JJ commented Mar 12, 2018

Pod6 is a new, and more modern version of Perl's POD.
Some additional changes to documentation and auxiliary files. Refs also Raku/doc#167, which I will happily close when this is accepted and released.

@JJ
Copy link
Contributor Author

JJ commented Apr 9, 2018

Any update on this?

@JJ
Copy link
Contributor Author

JJ commented May 2, 2018

Now that github-linguist/linguist#4083 has been merged, can we have a go at this one?

@Tyil
Copy link

Tyil commented May 15, 2018

No response from any maintainer here yet? I wonder if there's a way to get some more attention to this from them, since we're waiting for over two months to get feedback here.

@JJ
Copy link
Contributor Author

JJ commented May 15, 2018

Not really. It will probably have to be redone, if the new version of linguist is out...

@lildude
Copy link
Member

lildude commented May 30, 2018

As detailed at github-linguist/linguist#4083 (comment), I've had to revert the addition of Pod 6 support to Linguist as we can't roll it out to GitHub.com until markup has support to render Pod 6 files. A Linguist and markup release with support for Pod 6 will need to be made around about the same time (possibly even the same PR) to ensure users aren't left scratching their heads wondering why one pod file suddenly renders correctly and another doesn't (because it's now being detected as Pod 6 instead of Pod).

github-linguist/linguist#4149 is the new Linguist PR that adds back Pod 6 support and remains dependant on a similar markup PR, whether that be this one or another.

@JJ
Copy link
Contributor Author

JJ commented May 30, 2018

So what do you want me to do here?

@lildude
Copy link
Member

lildude commented May 30, 2018

Nothing is needed from you right now. Someone from one of the teams at GitHub responsible for markup will need to assess the two Pod 6 PRs, select the best and advise further.

@JJ
Copy link
Contributor Author

JJ commented May 30, 2018

OK. Just tell me who to send the fruit basket to help my cause :-)

@JJ
Copy link
Contributor Author

JJ commented Jun 24, 2018

Ping?

.travis.yml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
or

```
bundle install
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe do this change as a separate PR? There's already another one with some README additions that this might be combined with

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Which one do you mean?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lib/github/markups.rb Outdated Show resolved Hide resolved
test/markup_test.rb Show resolved Hide resolved
Co-Authored-By: JJ <jjmerelo@gmail.com>
@jordemort
Copy link
Contributor

One other thought, maybe it would be good to provide a fallback to https://metacpan.org/pod/distribution/Perl6-Pod/scripts/pod6xhtml, presuming that its output is acceptable? It's admittedly a little wacky to use Perl 5 to render Perl 6 docs, but on the other hand deploying a CPAN module to a server that already runs Perl 5 might be an easier sell for some folks' (read: likely mine) sysadmins than deploying Perl 6 to a thing that previously did not have it.

@kivikakk
Copy link
Contributor

Merged master, resolved PR review comments, added a Dockerfile so we can reproduce the results from Travis. (In particular, I needed to be able to actually run pod62html in the same environment/version that Travis does, in order to produce a README.pod6.html that matched the output expectation.)

The language detect test fails because Linguist can't recognise pod6 yet.

@kivikakk
Copy link
Contributor

It's admittedly a little wacky to use Perl 5 to render Perl 6 docs, but on the other hand deploying a CPAN module to a server that already runs Perl 5 might be an easier sell for some folks' (read: likely mine) sysadmins than deploying Perl 6 to a thing that previously did not have it.

@jordemort This seems like a good idea, but Perl6::Pod looks in need of maintenance -- last commit 3 years ago. I'm concerned it may be out of date, and as someone who doesn't use Perl (5 or 6) themselves I'm unqualified to determine whether it is in fact up-to-date or not.

The problem of getting Perl 6 deployed is still very real; I'll look into it.

@Tyil
Copy link

Tyil commented Dec 10, 2018

If it helps, there's a rakudo-star image available on hub.docker.org.

@kivikakk kivikakk merged commit 83d9824 into github:master Dec 12, 2018
@kivikakk
Copy link
Contributor

I'll make a new markup release now that this is working with the latest Linguist release, but there's still work left on our end to get Rakudo in the right places. (We're actively working on it, but there are lots of places where it needs to end up and the process is not simple.)

@JJ
Copy link
Contributor Author

JJ commented Dec 12, 2018 via email

@ghost ghost mentioned this pull request Feb 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants