Philip Durbin 🚀 (Apr 26 2024 at 15:41): Philip Durbin 🚀 (Apr 26 2024 at 15:41):As promised, I stubbed out a Contributor Guide: https://dataverse-guide--10532.org.readthedocs.build/en/10532/contributor/index.html
Philip Durbin 🚀 (Apr 26 2024 at 15:42):Here's the commit: https://github.com/IQSS/dataverse/pull/10532/commits/6b5ed03e5716d320d2a6f98178c41727b07ba6c2
Philip Durbin 🚀 (Apr 26 2024 at 15:44):The branch is under "pdurbin" and I'm happy to give others access to push: https://github.com/pdurbin/dataverse/tree/10531-contrib
Philip Durbin 🚀 (Apr 26 2024 at 15:44):Please just let me know your GitHub username.
Vaida Plankytė 🎨 (Apr 26 2024 at 16:08):awesome! i'm at vaidap :smile:
Philip Durbin 🚀 (Apr 26 2024 at 16:09):Added but I think you have to go here to accept? https://github.com/pdurbin/dataverse
Vaida Plankytė 🎨 (Apr 26 2024 at 16:16):i've got push access now! :sunglasses: glad to have this set up. once we've got a draft we're happy with in gdocs, we can work on writing it up in .md.
Philip Durbin 🚀 (Apr 26 2024 at 16:17):Yep, sounds good.
Philip Durbin 🚀 (Apr 26 2024 at 16:18):I put a little note at the top saying we plan to switch from one page to multiple.
Philip Durbin 🚀 (Apr 29 2024 at 16:13):@Vaida Plankytė should we link the google doc here so people can find it? That's were most of the conversation is happening.
Vaida Plankytė 🎨 (Apr 30 2024 at 10:38):good idea! I've set the link to be available to anyone with commenting permissions. Welcoming anyone to give their thoughts on what we should include in a Contributor's Guide! :big_smile: https://docs.google.com/document/d/1NG1cw8NqdUu_iFWFNUNIOL3sSjMVoP_uBL2ObZbmm60/edit?usp=sharing
Philip Durbin 🚀 (May 10 2024 at 15:33):@Vaida Plankytė and I just had a very productive meeting. We didn't get through all the feedback in the doc but we made several commits to the pull request: https://github.com/IQSS/dataverse/pull/10532/commits
As before, you can preview the upcoming Contributor Guide at https://dataverse-guide--10532.org.readthedocs.build/en/10532/contributor/
The Google doc might be a little hard to read right now because we rewrote parts of it and jotted down ideas but please feel free to keep adding comments.
Comments are also welcome here in Zulip, of course. Plus there's the thread on the google group: https://groups.google.com/g/dataverse-community/c/ejJrJmH6ojI/m/7xTxRfNMBAAJ
Vaida Plankytė 🎨 (May 10 2024 at 15:48):thanks for writing up the update-- beat me to it! :big_smile: it's great we're making progress. it makes sense to continue on this next time-- cleaning up this introductory page, and start to figure out what content needs to have its own page!
Philip Durbin 🚀 (May 10 2024 at 15:49):There's a surprising amount to talk about. Even just the :thumbs_up: discussion on issues.
Philip Durbin 🚀 (May 10 2024 at 15:50):Listing all the code one can contribute to, based on language.
Philip Durbin 🚀 (May 10 2024 at 15:50):Oh, I did add that commit I talked about, to link to the "reporting security issues" section: https://github.com/IQSS/dataverse/pull/10532/commits/4eede606ebabddc71705a76915fff0cc774f790b
Vaida Plankytė 🎨 (May 10 2024 at 15:54):Philip Durbin said:
There's a surprising amount to talk about. Even just the :thumbs_up: discussion on issues.
absolutely! documentation writing can be such a rabbit hole, but when well considered, it can facilitate so much. so i'm glad we're doing this work to hopefully improve people's experiences. :sunglasses:
Vaida Plankytė 🎨 (May 10 2024 at 15:55):once we are done with this page, we should definitely compare with what the page looked like at the start! it'll let us step back and see what initial guidelines we can write up based on our experience.
Philip Durbin 🚀 (May 10 2024 at 15:56):Use more bullets? :grinning:
Fewer walls of text? :wall:
Vaida Plankytė 🎨 (May 12 2024 at 12:41):and replacing / with and or & both for readability and searchability! :sunglasses:
Vaida Plankytė 🎨 (May 12 2024 at 12:41):context for others: "File Upload/Download" header works better as "File Upload and Download"
Philip Durbin 🚀 (Jun 07 2024 at 16:03):Ok! @Vaida Plankytė @Dieuwertje Bloemen and anyone else who's interested, please check out the newly reorganized Container Guide at https://dataverse-guide--10532.org.readthedocs.build/en/10532/contributor/index.html !
Philip Durbin 🚀 (Jun 07 2024 at 16:04):To summarize, we're experimenting with putting more content right in the index page.
Philip Durbin 🚀 (Jun 07 2024 at 16:04):If you look at older guides, the index page is just a dump of the table of contents.
Philip Durbin 🚀 (Jun 07 2024 at 16:07):The tricky thing is that we do have a subpage (code.md), so I had to put it somewhere. So I put this under the Code section:
...To get started, please see the following pages:
```{toctree}
:maxdepth: 1
code.md
```
It's slightly awkward but I can't think of a better way. If I add :hidden: the page becomes an orphan, which is worse.
Philip Durbin 🚀 (Jun 07 2024 at 16:09):Anyway, feedback is very welcome!
I think I'm ready to go ahead and remove "draft" from https://github.com/IQSS/dataverse/pull/10532 and see if we can get this merged as an initial Contributor Guide. We'll iterate on it in the future, of course. What do you think?
Philip Durbin 🚀 (Jun 10 2024 at 14:40):I see a :thumbs_up: from @Dieuwertje Bloemen (thanks).
What do you think, @Vaida Plankytė ? Are you ok with that pull request being merged as-is?
Vaida Plankytė 🎨 (Jun 10 2024 at 19:48):Yes, do go ahead @Philip Durbin! It'll be great to get this merged! :grinning_face_with_smiling_eyes:
Philip Durbin 🚀 (Jun 10 2024 at 19:52):Cool, I'll take one last look for typos and move it into "ready for review".
At some point I'd like to add some tips on finding issues to work on (@Jose Lucas Cordeiro mentioned this) but it can wait.
Philip Durbin 🚀 (Jun 11 2024 at 03:05):We already had tips. I just linked to them: https://github.com/IQSS/dataverse/pull/10532/commits/36b4ed99636f55f794c332f6fff8d829ea691a9a
Philip Durbin 🚀 (Jun 13 2024 at 13:30):I added a few more areas where people can contribute:
Feedback welcome!
Philip Durbin 🚀 (Jun 13 2024 at 16:27):I also created a subpage at source/contributor/documentation.md (like we had already for code.md).
And I deleted the content from source/developers/documentation.md after moving it to the new page.
Philip Durbin 🚀 (Jun 13 2024 at 16:35):Ok! I finally put https://github.com/IQSS/dataverse/pull/10532 into "Ready for Review".
Please take a look, leave a review if you like (I can coach you through this if you aren't familiar), or leave feedback here or wherever.
Again, you can preview it at https://dataverse-guide--10532.org.readthedocs.build/en/10532/contributor/index.html
Julian Gautier (Jun 13 2024 at 17:44):I like the artwork section! :big_smile:
Philip Durbin 🚀 (Jun 13 2024 at 17:55):Ha, I just showed that contributor that you liked it. (She's home sick today.)
Dieuwertje Bloemen (Jun 21 2024 at 13:25):@Vaida Plankytė Is there a UX Contributor guide meeting this afternoon? Or is it cancelled because I believe Phil is on leave?
Vaida Plankytė 🎨 (Jun 21 2024 at 13:35):oh, I didn't realise he was! if you're up for it, we can celebrate our hard work by taking this session off? :big_smile:
Vaida Plankytė 🎨 (Jun 21 2024 at 13:35):i'll annotate it in the calendar event if so
Dieuwertje Bloemen (Jun 21 2024 at 13:36):Is fine by me, that way we can celebrate Phil's hard work as well :sweat_smile:
Vaida Plankytė 🎨 (Jun 21 2024 at 13:37):noice, have tagged it as cancelled. have a great weekend! :big_smile:
Dieuwertje Bloemen (Jun 21 2024 at 13:37):you too!
Philip Durbin 🚀 (Jul 01 2024 at 16:18):I just merged the contributor guide PR! #10532
Philip Durbin 🚀 (Jul 01 2024 at 16:23):You can now see it at https://preview.guides.gdcc.io/en/develop/contributor/index.html
Philip Durbin 🚀 (Jul 01 2024 at 16:23):This definitely isn't the final version. Please feel free to open issues and pull requests to improve it!
Philip Durbin 🚀 (Jul 03 2024 at 20:55):It looks like "new Contributor Guide" got top billing at https://dataverse.org/blog/dataverse-software-63-release ! :tada:
Notification Bot (Jul 19 2024 at 17:52):This topic was moved here from #ux-wg > Contributor Guide by Philip Durbin.
Last updated: Nov 01 2025 at 14:11 UTC