Make a complete authors section on Dancer2.pm #452

Closed
ambs opened this Issue Sep 11, 2013 · 12 comments

Projects

None yet

4 participants

@ambs
Member
ambs commented Sep 11, 2013

As discussed with @bigpresh and @shadowcat-mst (and I think @xsawyerx read the backlog), add a complete list of Authors, Contributors and Sponsors in Dancer2.pm POD.

With that, probably we can get rid of AUTHORS file (maintain two lists would be headache)

@xsawyerx
Member

👍
Yes!

@gideondsouza
Contributor

Should I do this?

Is this as simple as editing the Dancer2.pm file? But dist zilla generates the authors section of the POD. Doesn't seem like dist zilla supports a list of authors.

@bigpresh
Member

My personal opinion would be to allow Dist::Zilla to generate the authors section of the POD if it already does, and just add contributors and sponsors sections directly in the POD in Dancer2.pm after the authors section - if we can control where the authors section goes. Otherwise, f**k Dist::Zilla and put it all in there manually.

@ambs
Member
ambs commented Sep 13, 2013

👍

@gideondsouza
Contributor

Oh also I'm not sure about authors vs contributors. The AUTHORS file here has a Core Developers section and a Contributors section. So Core Developers eq Authors. Also, where is the list of sponsors?

@bigpresh I can't seem to find anything about putting multiple authors into the authors section on Dist::Zilla. I'll keep digging for a bit. (I've generally been having difficulties getting dist zilla on my own projects)

If we do also put it in the POD directly under a section named "Author" won't this cause a problem with dist zilla, like a duplicate authors section in the pod?

@ambs
Member
ambs commented Sep 13, 2013

we do not have sponsors atm :) as far as I know.

@bigpresh
Member

On Fri, 13 Sep 2013 05:31:29 -0700
Gideon Israel Dsouza notifications@github.com wrote:

Oh also I'm not sure about authors vs contributors. The AUTHORS
file here has a Core Developers section and a Contributors
section. So Core Developers eq Authors ?

Yup, spot on.

@bigpresh I can't seem to find anything about putting multiple
authors into the authors section on Dist::Zilla. I'll keep digging
for a bit. (I've generally been having difficulties getting dist
zilla on my own projects)

If we do also put it in the POD directly under a section named
"Author" won't this cause a problem with dist zilla, like a duplicate
authors section in the pod?

I too don't get on with D::Z so well - if it can't handle multiple
authors, then we should be able to tell it not to try to add authors to
the POD, and just add them manually - I'd assume that's possible.

@gideondsouza
Contributor

@ambs from the time I've spent these past weeks looking at d::z , there is
a picky pod weaver plugin which will not generate pod if there isn't an
#abstract in the pm file.

But this means we will have to include other stuff like license manually.

I'll keep digging and see if there is anything else.

@xsawyerx
Member

Moving to next milestone. We can afford to wait one more release with this one.

@ambs
Member
ambs commented Sep 15, 2013

Yep, thank you @xsawyerx.

@gideondsouza
Contributor

I got pretty side tracked and forgot about this! Sorry!

I still haven't figured whether I can put a paragraph inside the dist.ini for authors? I can make a separate =head1 for contributors and sponsors.

Maybe @dagolden would know? : If I can't put multiple authors into the dist.ini can I prevent Dist::Zilla from generating JUST this section? (Or do have to go manual on the whole Dancer2.pm pod?)

@xsawyerx
Member
xsawyerx commented Dec 7, 2013

Fixed by Pau Amma as part of Patch.pm p1 hackathon.

@xsawyerx xsawyerx closed this Dec 7, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment