Page MenuHomePhabricator

Outreachy Round 27: Improve documentation of Programs & Events Dashboard
Open, Needs TriagePublic

Description

IMPORTANT: Make sure to read the Outreachy participant instructions and communication guidelines thoroughly before commenting on this task. This space is for project-specific questions, so avoid asking questions about getting started, setting up Gerrit, etc. When in doubt, ask your question on Zulip first!

Brief summary

Programs & Events Dashboard — https://outreachdashboard.wmflabs.org/ — is a web application for keeping track of the contributions of groups of editors participating in edit-a-thons, wiki editing courses, and other projects focused on contributing to Wikipedia, Wikidata, and other Wikimedia wikis.

It has a set of documentation pages — https://meta.wikimedia.org/wiki/Programs_%26_Events_Dashboard — as well training modules hosted on the platform itself — https://outreachdashboard.wmflabs.org/training — that provide information on how to use various features of the Dashboard. However, these don't cover all the most common questions that people have. Improved documentation — including demo videos — is one of the top requests from Dashboard users.

For this project, you will review existing documentation, as well as survey responses from the most recent Dashboard user survey, identify high-priority areas for documentation improvement, and then implement those improvements. Along the way, you may find bugs or inconsistencies in the Dashboard user experience, which you should document as new Issues, and you may find it helpful to contact individual users to learn more about their use cases and documentation needs.

Both the on-wiki documentations pages and the integrated training modules are translatable and available in multiple languages, but the English version is the source that volunteer translators of the documentation can work from, and improving that source version will be the focus of this project.

To get started, you should set up a Dashboard development environment so that you will easily be able to explore the system and use all the features in a non-production environment. See https://github.com/WikiEducationFoundation/WikiEduDashboard

Email sage at wikiedu.org to request an invite to the project's Slack chat.

Relevant skills

  • Written and Spoken English communication skills - required
  • Video production / screencasting - highly useful, but not required
  • Ruby & JavaScript - helpful for troubleshooting but not required
  • Familiarity with wikis and/or Wikidata - helpful but not required
  • Experience with or interested in user research - helpful but not required

Microtasks

Mentors

Event Timeline

Hey @Ragesoss Thank you so much for offering to mentor! It appears to be a fantastic project.

Here are a few suggestions/questions:

  • This part of the description looks incomplete, kindly complete to help interns fully understand the project“Both the on-wiki documentations pages and the integrated training modules are translatable and available in multiple languages, but the”.
  • There are a couple of tasks listed out in the description, would this take three months of work for a new contributor? How long do you estimate it would take?
  • Do you have a second mentor in mind for this project? We recommend that each project has two mentors, with at least one mentor with a technical background.
  • Lastly can you please add your project here https://www.mediawiki.org/wiki/Outreachy/Round_27 under “Ideas for Project” and help promote it via the mailing lists? You can simply reply to the thread here: https://lists.wikimedia.org/hyperkitty/list/wikitech-l@lists.wikimedia.org/thread/IPGTE5XVAZ32DO3NWDSDQW2A3A4NZB5X/

Thank you!

Thanks @Maryann-Onyinye!

I fixed that truncated portion of the project description.

I will recruit a second mentor.

The core tasks involved would be to a) identifying high-priority documentation topics for improvement, and b) improving those via improving the text-based documentation and/or creating video-based resources. Proposing a more specific scope for three months of work in that area would be the task of an applicant developing a strong Outreachy proposal.

Great @Ragesoss! Thank you for making the needed changes!

I formatted the media wiki pages and added some information, feel free to look through and edit/update accordingly. (https://www.mediawiki.org/wiki/Outreachy/Round_27).

Can you please help promote your project via the mailing list? You can simply reply to the thread here: https://lists.wikimedia.org/hyperkitty/list/wikitech-l@lists.wikimedia.org/thread/IPGTE5XVAZ32DO3NWDSDQW2A3A4NZB5X/

Lastly please submit your project proposal on Outreachy's website via this link: https://www.outreachy.org/outreachy-december-2023-internship-round/communities/wikimedia/submit-project/

Thank you!

Hi Hi,

Gentle reminder to submit your project proposal on Outreachy Website & promote your project via the mailing list (relevant links below).

Thank you

Thanks @Maryann-Onyinye!

I fixed that truncated portion of the project description.

I will recruit a second mentor.

The core tasks involved would be to a) identifying high-priority documentation topics for improvement, and b) improving those via improving the text-based documentation and/or creating video-based resources. Proposing a more specific scope for three months of work in that area would be the task of an applicant developing a strong Outreachy proposal.

Hi Sage! This looks like a really nice project and I think I can relate to it quite a lot since when I started contributing to the Wikipedia project for my Outreachy internship I felt lost in the Programs and Events dashboard and the video mocks would have helped a lot but its always better late than never. I wanted to show my interest in being a co-mentor for this project if you would like. I have earlier worked on a Wikipedia project in this cohort (Link to our Project) in which I along with my co-intern is working to research into translation imbalances in different language versions of Wikipedia.

srishakatux changed the visibility from "Public (No Login Required)" to "acl*outreachy-mentors (Project)".Sep 6 2023, 8:32 PM

@Maryann-Onyinye See bullet point 3 here: https://www.mediawiki.org/wiki/Outreachy/Mentors#_Before_the_program. Let's restrict access to users for this project pre-application period.

@Ragesoss If anyone else needs to be added to the restricted group as mentors, let us know.

Maryann-Onyinye changed the visibility from "acl*outreachy-mentors (Project)" to "Public (No Login Required)".Oct 2 2023, 1:55 PM