Atlanta Write the Docs Meetup Hacktoberfest Documentation Project, Session 2
October 10, 2020 10 AM to 2 PM EDT
Theme: Know Your Audience
The Atlanta Write the Docs Meetup is hosting events throughout the month of Hacktoberfest in order to help open source projects with their documentation. Our events are open and welcoming to anyone who wants to contribute to the documentation for open source projects, no matter where you're located. You can participate as little or as much as you want. Everyone is welcome, and everyone is here to learn and enjoy themselves.
More information on Hacktoberfest here: Hacktoberfest home
What We'll Accomplish
This week's event is a doc sprint, where we will analyze documentation needs for the Ubuntu MATE, an official flavor of the Linux distribution Ubuntu. Specifically, we will work with the Web development and QA teams to improve and evolve bug reporting and bug-related pages on the website to make them clearer and more useful for community members. We’ll work on the following pages:
- Bug Reporting and Triage 5
- Bug Fixing
1. Understanding the web team’s goals and requirements for the bug-related pages, including a walk through of an example of a distro or project that does a great job with their bug guide.
2. Gaining insight into potential audience for the pages and their needs
a. For people who are new to bug reporting/triage/fixing, what information/steps/screenshots would help the most?
b. For people seasoned with all things bug, what resources do they wish they had, either now or when they were learning?
3. Working session to create a work plan
a. Identify what documentation is needed: net new, edits and improvements
b. Identify what documentation the team can deliver during Hacktoberfest
c. Participants to choose what they’ll contribute and how they’ll collaborate
10:00 AM to 12:00 PM – Collaborate with Ubuntu MATE Web development and QA team
Learn about Ubuntu MATE product and bug reporting features. Review current bug reporting guidance documentation, and hear the Ubuntu MATE team’s perspectives on gaps and improvement opportunities.
12:00 PM to 1:00 PM – Work Planning
The group will collectively identify work segments, determine what we can accomplish during Hacktoberfest, and commit to delivering work segments.
1:00 PM to 2:00 PM – Writing Time
Writers can coordinate with writing partners or go heads down to start producing.
Rules of the Road
This event is covered by the Write the Docs Code of Conduct, which states that "we are dedicated to providing a safe, inclusive, welcoming, and harassment-free space and experience for all community participants." You can find more information at the link above.