Improving Experience of Contributors - how can the documentation be better?

105 views
Skip to first unread message

Vaida Plankyte

unread,
Apr 26, 2024, 9:00:35 AMApr 26
to Dataverse Users Community
Hi all!

Wanted to let you know about the newly formed "Improving contributor guidance" working group, which is meeting every second Friday at 15:00 – 16:00 UTC +1 (including today, April 26th). It's part of the larger UX working group effort.

We're starting by reviewing the Dataverse documentation experience, and would love your feedback on what you think can be improved and would yield the most benefit to old and new contributors alike: formatting/styling, content hierarchy, search, layout...

Feel free to post any thoughts below, or join the working group any time it's on! We're friendly, and usability experts say the more the merrier :)

Philip Durbin

unread,
May 3, 2024, 9:51:15 AMMay 3
to dataverse...@googlegroups.com
Yes, this new Improving Contributor Guidance working group is a lot of fun and we welcome more people to join!

As Vaida mentioned, one idea we have is to expand our CONTRIBUTING.md file into an entire Contributor Guide. If you're interested in this, please leave comments on this google doc: https://docs.google.com/document/d/1NG1cw8NqdUu_iFWFNUNIOL3sSjMVoP_uBL2ObZbmm60/edit?usp=sharing


We have lots of other ideas as well. Please feel free to read and comment on our notes at https://docs.google.com/document/d/1EaHMzCiabiQXVAf1s8kO0kdk2bQADZhwzAyD1P8XO6s/edit?usp=sharing

We meet every other Friday (today is an off week). Meetings are posted in the community calendar: https://calendar.google.com/calendar/embed?src=c_udn4tonm401kgjjre4jl4ja0cs%40group.calendar.google.com&ctz=America%2FNew_York

Thanks!

Phil

--
You received this message because you are subscribed to the Google Groups "Dataverse Users Community" group.
To unsubscribe from this group and stop receiving emails from it, send an email to dataverse-commu...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/dataverse-community/69360a15-f716-4092-a8b1-f23a7399f2d8n%40googlegroups.com.


--

Vaida Plankyte

unread,
May 10, 2024, 8:03:37 AMMay 10
to Dataverse Users Community
Hi all,

A quick reminder to let you all know the Contributors Guidance working group is meeting today (Friday) at 15:00 – 16:00 UTC +1. We'll be reviewing all of our notes on the Contributors Guide, and agreeing on the changes/additions we'd like to make. Feel free to add more comments to the document and/or join us for the meeting today! 😊 https://docs.google.com/document/d/1NG1cw8NqdUu_iFWFNUNIOL3sSjMVoP_uBL2ObZbmm60/edit?usp=sharing

Philip Durbin

unread,
Jun 13, 2024, 1:19:47 PMJun 13
to dataverse...@googlegroups.com
Good news! A draft version of the upcoming Contributor Guide is now available for review. It was co-authored mainly by Vaida, Dieuwertje, Jay, and myself.


If you have any feedback, you can simply reply to this thread or in Zulip: https://dataverse.zulipchat.com/#narrow/stream/434038-ux-wg/topic/Contributor.20Guide/near/444466080

You're also welcome to leave feedback on the pull request itself: https://github.com/IQSS/dataverse/pull/10532

Thanks,

Phil

p.s. One thing to notice about this new guide is that the index page has actual content instead of a hierarchical list of subpages.


Philipp Conzett

unread,
Jun 14, 2024, 11:11:49 AMJun 14
to Dataverse Users Community

Hi Vaida, Dieuwertje, Jay, and Phil,

Thanks a lot for working out these guidelines! This is a valuable resource for the community! Here's some feedback from me:

1. After the section Working Groups, I suggest adding a section about GDCC along these lines:

GDCC
The popularity of the Dataverse software has resulted in a continuously growing community with different needs and requirements. The Global Dataverse Community Consortium (GDCC) helps coordinate community efforts and sustain the software and community in the long term. Please consider contributing to GDCC by joining as an institutional member (https://www.gdcc.io/members.html).

2. A few minor suggestions as commented in our Dataverse hypothes.is group: https://hypothes.is/groups/NqwAMwE3/dataverse.

Best,
Philipp

Philip Durbin

unread,
Jun 14, 2024, 11:51:45 AMJun 14
to dataverse...@googlegroups.com
Thanks, Philipp! I just incorporated your feedback (and signed up for Hypothesis): https://github.com/IQSS/dataverse/pull/10532/commits/946d1ddd75e24d053ddd0ed0ad4e0b4b848b0fd8

Reply all
Reply to author
Forward
0 new messages