Skip to content

Loading…

add section if help is wanted #612

Merged
merged 1 commit into from

5 participants

@yanick

The whole motivation for the patch is at http://babyl.dyndns.org/techblog/entry/help-wanted

In a nutshell: add a sidebar item on the release webpage if the x_help_wanted element is set in the META information.

@leto

+1

@dpetrov

+1 from me also

@oalders
MetaCPAN member

@yanick Thanks very much for this. :) Can you give me a release this can be tested against?

@yanick

Dist-Zilla-Plugin-HelpWanted should have the position of 'coder' open. :-)

@monken
MetaCPAN member

This patch alone won't do since there is no x_help_wanted property in ElasticSearch yet.
We can either add that (which I dislike because we would have to change the schema for each of those fields) or we start implementing "tags" for releases and modules.
Third option: we stick the content of META.yml/json files in ES unparsed and parse it when necessary.

@yanick

Argh! I thought $release was only the straight serialization of the META information. I would even advance that I saw it works on Dist-Zilla-Plugin-HelpWanted, but now that you said that, @monken, you make me wonder. :-)

If that's the case, yeah, it'd be nice to have the straight META information in ES so that we can toy with ad-hocish new fields (like this one) without any major changes to the backend.

@monken
MetaCPAN member
@monken monken was assigned
@yanick

And I just confirmed that I hallucinated that the 'help wanted' section was showing. I must have checked on a branch where I fudged things to show mock information. I shall never doubt you again, monken. :-)

@monken
MetaCPAN member

@yanick hehe, I've been wrong so many times, I don't mind being doubted at all ;)

@monken
MetaCPAN member

I patched the api to include the META data
https://api.metacpan.org/release/Dist-Zilla-Plugin-HelpWanted see the metadata key.
Your code needs some adjustments to get the x_help_wanted from the metadata key.

@yanick

Code fixed to see the metadata, and rebased to the head of master for ease of merge. Thanks, @monken!

@oalders oalders merged commit 9e5005c into CPAN-API:master
@oalders
MetaCPAN member

@yanick Thanks so much for this! The "help wanted" message itself seems a bit subtle. I had trouble finding it and I was actually looking for it. :) Maybe we could style it a bit in a way that catches the eye a bit more.

@yanick

@oalders Very true. As a first stab, I didn't want to be too bold. But that can change. ;-)

Something else I want to add is a "inquire within" link under the message, which will list ways to actually contact the maintainers if one wants to help (CPAN email addresses of the authors, mailing list url if there's one in the resources)

@szabgab szabgab pushed a commit to szabgab/cpan-api that referenced this pull request
@monken monken index META files in metadata property, refs CPAN-API/metacpan-web#612 17998e3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Aug 2, 2012
  1. @yanick

    add section if help is wanted

    yanick committed
This page is out of date. Refresh to see the latest.
Showing with 9 additions and 0 deletions.
  1. +9 −0 root/release.html
View
9 root/release.html
@@ -35,6 +35,15 @@
</ul>
<hr>
<% INCLUDE inc/activity.html query = 'distribution=' _ release.distribution %>
+<% IF release.metadata.x_help_wanted %>
+ <hr>
+ <strong>Help Wanted</strong>
+ <ul>
+<% FOREACH position IN release.metadata.x_help_wanted %>
+ <li><% position %></li>
+<% END %>
+ </ul>
+<% END %>
<hr>
<strong>Permalinks</strong>
<ul>
Something went wrong with that request. Please try again.