Page MenuHomePhabricator

[Proposal] Add support for tracking specific namespaces to Programs & Events Dashboard
Open, Stalled, Needs TriagePublic

Description

Profile Information
Name : Selene Flores
Github: https://github.com/enelesmai
Linkedin : https://www.linkedin.com/in/xochitlselene/
Location : Colima, Mexico
Typical working hours (include your timezone) : 8AM to 4:00 PM (-6:00 UTC)

Outreachy Link: https://www.outreachy.org/outreachy-may-2022-internship-round/communities/wikimedia/#add-support-for-tracking-specific-namespaces-to-pr

Name:
Add support for tracking specific namespaces to Programs & Events Dashboard

Type of project: Milestones

Description:
Add support for tracking specific namespaces to Programs & Events Dashboard

Programs & Events Dashboard is a complex web app for keeping track of contributions to Wikimedia projects. It's widely used by the global Wikimedia community for edit-a-thons, classroom wiki writing assignments, and a variety of other initiatives.

The goal of this project is to improve the system's flexibility by adding support for program organizers to specify which namespaces they want to count statistics for.

Possible tasks include:

  • Designing and implementing a UI for selecting which namespaces to track
  • Updating event statistics update process to account for namespace setting
  • The Dashboard is primarily built with the React JavaScript framework (for the frontend), and Ruby on Rails (for the backend). It will require knowledge of JavaScript, and either knowledge of Ruby or a strong interest in learning Ruby.

Canonical code repository URL of the project (if this project has a code base):
https://github.com/WikiEducationFoundation/WikiEduDashboard/blob

Possible Mentor(s):
Ragesoss

Have you contacted your mentors already?:
Yes

Plan:
Purpose:
Improve the system's flexibility by adding support for program organizers to specify which namespaces they want to count statistics for.

Note: each period of time will be iterative and it will be expected that the deliverables are reviewed periodically before the deadline of the iteration, in order to make early improvements or corrections.

Timeline:
May 30th - June 10th
Research and document current functionality and
Deliverable:

  • Code documentation and necessary diagrams

June 13th - June 24th
Analyze and design process to track namespaces.
Deliverable:

  • List of requirements
  • Schemes and/or maps / diagrams for the process
  • Test Plan (list of test cases)

June 27th - July 8th
Design the UI to track namespaces
Deliverable:

  • UI mockups

July 11th - July 22nd
Code functionalities listed on the previous deliverables, event statistics update process
Deliverable:

  • Scripts to create model or schema changes (in case it is necessary)
  • Well documented and tested functionalities

July 25th - August 5th
Implement UI and integrate functionalities
Deliverable:

  • Well documented and tested UI

August 8th - August 12th
Enlarge test coverage to test fail and limit scenarios.
Deliverable:

  • PR for full implementation

August 15th - August 26th

  • Make corrections and improvements to the code
  • Document issues, possible improvements and future work.

Participation:
I have already forked the repo and have worked on my branch, but will also create new branches for the different stories. I will use clear messages on the commits and specify in each Pull Request what is going to be merged.
The code will be periodically pushed and reviewed.
I will be reachable on Slack on my working ours ( 8AM to 16:00 hrs (-6:00 UTC)).
I will be reachable via email for any kind of emergency or problem.
I will document the whole process and the code being written.
I will create the code with specific documentation and using best practices being as clear as possible.

About me:
I'm a software engineer with 8+ years of software development experience using multiple languages and frameworks as Ruby, Javascript (Vanilla), Ruby on Rails, React and NodeJS. I describe myself as a goal and team oriented worker.

  • Now learning and developing with Elixir and Phoenix framework 🔥, and looking to contribute in Ruby on Rails to get more experience on this framework.

Past experience:
I have contributed to open source for documentation, at railsbridge (http://es.railsbridge.org/docs/) and codificadas repository (https://github.com/codificadas)

Wikimedia contributions:
Work in progress or finished:
https://github.com/WikiEducationFoundation/WikiEduDashboard/pull/4914
https://github.com/WikiEducationFoundation/WikiEduDashboard/issues/924

A final note:
I will be ready to work full time from the day Internship period begins (May 30th) for at least 40 hours a week throughout the week.

Event Timeline

Aklapper changed the task status from Open to Stalled.Apr 22 2022, 4:41 PM

Hi @Enelesmai, https://github.com/WikiEducationFoundation/WikiEduDashboard/issues exists for issue tracking and planning. Is that not sufficient?
If you need a project in Wikimedia Phabricator instead for some reason, please see https://www.mediawiki.org/wiki/Phabricator/Creating_and_renaming_projects . The content above looks more like an application instead?

I'm really not sure what to make out of this task. It looks like an Outreachy application (though https://www.mediawiki.org/wiki/Outreachy/Participants#Application_process_steps states that creating a ticket isn't needed for that)? @srishakatux, @Enelesmai: Any ideas?

srishakatux moved this task from Backlog to Proposals In Progress on the Outreachy (Round 24) board.

Confirming that @Enelesmai is an Outreachy applicant. Adjusting tags accordingly..

Aklapper renamed this task from Create project tag for <Add support for tracking specific namespaces to Programs & Events Dashboard> to [Proposal] Add support for tracking specific namespaces to Programs & Events Dashboard.May 10 2022, 7:18 AM