Docs Hackathon Jan 2023 planning issue
Hackathon info
We'll use this issue to plan logistics around the Docs Hackathon planned for January 2023.
- Dates: 23 - 27 January 2023
- Hackathon website: https://about.gitlab.com/community/hackathon/
- List of available Hackathon issues: All docs-only issues, Non-confidential issues
- Issues assigned: Assigned issues
- Issues resolved: Closed and with Hackathon label
-
Group alias:
@docs-hackathon
(group info here) - Retro issue: #748 (closed)
Volunteers
If you would like to help out during the Hackathon, please add your name to this list:
Process during Hackathon
Make issues available to work on
The list of issues above contains Vale issues that are marked confidential. Our current idea is to make a batch of those issues public just before the Hackathon starts, and continue 'releasing' more batches over the week. This is to avoid a large influx of pings in one go. @kpaizee
and @sselhorn
will manage this process.
Suzanne will release the first batch on 18th Jan.
Triage and assign issues to contributors
When a contributor pings @gl-docsteam
or @docs-hackathon
on an issue and asks to be assigned:
- Check that the issue isn't already assigned. If it is, point this out to the contributor and encourage them to look for unassigned issues.
- If multiple contributors ping on the same issue, assign to the contributor who asked first.
- After assigning the issue, let the contributor know and include the following info in the comment:
- If you haven't already, please RSVP at [our meetup.com event](https://www.meetup.com/gitlab-virtual-meetups/events/290691107/) to have your MRs count towards the prizes. - All qualifying MRs must be submitted between January 23rd 12:00 UTC & January 27th 12:00 UTC and be merged by February 15th at 23:00 UTC.
- Remove the Seeking community contributions label, so that the issue no longer appears on the list.
- Keep track of how many issues are assigned to a single contributor. To keep things fair, we limit contributors to three docs-only issues at a time. If a contributor is already assigned three issues, tell them that you won't assign the issue, but they're welcome to ping us again when they're finished working on their assigned issues.
- To check how many issues a contributor is already assigned, go to their issues list:
https://gitlab.com/dashboard/issues?assignee_username=username_without_@
. They may be working on other code issues, which is fine.
- To check how many issues a contributor is already assigned, go to their issues list:
- Keep track of the issues and close them when the related MR has been merged. Apply the current milestone to the issue and apply the Hackathon label. Issues must be closed by 15th February to qualify for prizes.
Known issues for contributors
Contributors are not members of the gitlab repo, therefore they must create a fork to contribute. Instructions for contributors: https://docs.gitlab.com/ee/development/documentation/workflow.html#how-to-update-the-docs
Out of date forks
Occasionally, contributors that have taken part in previous Hackathons use the same fork they created then and do not keep it up to date. The fork will be thousands of commits behind master
and the resulting MR riddled with merge conflicts. If this happens, encourage them to update their fork using these instructions: https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html#update-your-fork
Web IDE bug
A lot of first-time contributors create MRs directly from the UI. The old web IDE prompted contributors to create a fork first, but the new web IDE does not. Instead, contributors get a vague error when they try to commit. This is a bug/regression: gitlab#387165 (closed)
If contributors reach out to us because of this error, encourage them to switch to the old Web IDE. Go to https://gitlab.com/-/profile/preferences
and select Opt out of the Web IDE Beta.