nexusformat / definitions

Definitions of the NeXus Standard File Structure and Contents
https://manual.nexusformat.org/
Other
26 stars 55 forks source link

Make list of maintainers for application definitions #1254

Closed phyy-nx closed 1 year ago

phyy-nx commented 1 year ago

One of the ideas that came out of the April 2023 telco (minutes), during discussion of #1011, was that it would be a good idea to add "maintainers" to application definitions. These would be people who are most interested in guiding the maintenance and development of a given definition, or have an interest in it as a community member, or were long time contributors to it and can guide new users in its use or answer questions. Critically, they wouldn't need to be NIAC members.

I'm happy to set this up, my question is, where should it live?

Proposals:

  1. Add lists of application definitions to NIAC members on the NIAC web page.
  2. Add contact information (github handles?) to the list of application definitions
  3. Add contact information (github handles?) to individual definitions. Perhaps in the the form of a new attribute or field? Or in the doc string?

Or some combination of the above. Thoughts on this? Thanks!

zjttoefs commented 1 year ago

I'm opposed to that idea.

rayosborn commented 1 year ago

@zjttoefs, it's possible that "maintainer" is the wrong word, but I think it is essential that there is a point-of-contact for each active application definition, one who is aware of its history and current status and can respond to questions. There are several ADs that were thrown together a long time ago (I'm sure I contributed to at least one) but have never been properly validated by the community and sometimes never used. However, a newcomer would assume that use of this definition is mandatory, even if it is inadequate to their needs. It is like coming across a PyPI package that hasn't been updated in ten years or more, whose original author is unreachable. Would you use it?

phyy-nx commented 1 year ago

I can see nervousness around scope here and I agree I'm not quite sold on the word maintainer. "Helpful explainer" is more the vibe I was going for. But one additional point for @zjttoefs is that for probably most users of NeXus not related to this committee, the github page for eg NXmx, which has 11 contributors, is completely hidden compared to the manual page, which has no point of contact listed.

prjemian commented 1 year ago

I'm thinking contact might convey the meaning we want. Could modify it such as NeXus contact and science contact to identify different roles.

On Mon, Apr 24, 2023, 11:39 AM Aaron S. Brewster @.***> wrote:

I can see nervousness around scope here and I agree I'm not quite sold on the word maintainer. "Helpful explainer" is more the vibe I was going for. But one additional point for @zjttoefs https://github.com/zjttoefs is that for probably most users of NeXus not related to this committee, the github page for eg NXmx https://github.com/nexusformat/definitions/blob/main/applications/NXmx.nxdl.xml, which has 11 contributors, is completely hidden compared to the manual page https://manual.nexusformat.org/classes/applications/NXmx.html#nxmx, which has no point of contact listed.

— Reply to this email directly, view it on GitHub https://github.com/nexusformat/definitions/issues/1254#issuecomment-1520497496, or unsubscribe https://github.com/notifications/unsubscribe-auth/AARMUMF6MPUM6XIT5QNBYS3XC2UDBANCNFSM6AAAAAAXHGH7FA . You are receiving this because you are subscribed to this thread.Message ID: @.***>

phyy-nx commented 1 year ago

Compromises discussed in Code Camp: take advantage of the side bar space on the right hand of the page and add one or more of the following under the "This Page" heading:

image

Thoughts?

prjemian commented 1 year ago

side bar space on the right hand of the page

Which page? Can you give an example?

phyy-nx commented 1 year ago

Ya, here's a screenshot of where I mean:

image