Page MenuHomePhabricator

Outreachy Round 29: Quickstatements 3.0 public documentation
Open, In Progress, 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

The objective of Quickstatements v3 is to enhance the functionality, performance, and user experience of the QuickStatements platform. This enhancement aims to incorporate new features, address existing issues, improve system stability, and ensure compatibility with the latest technologies and standards.

The internship project aims to collaborate on the development and public documentation of the new version of the Quickstatements tool (v3), currently being developed by the Wiki Movimento Brasil (WMB). Quickstatements is a widely used tool for inserting and modifying data on Wikidata, one of Wikimedia's platforms.

This internship offers a unique opportunity to directly participate in an open-source project with significant impact on the Wikimedia community, as well as contribute to the dissemination of technical knowledge in the field of data submission and manipulation.

Skills

  • Django (comfortable)
  • GitHub (comfortable)
  • Wikitext (no knowledge required)

Mentor(s)

@Ederporto, @Mgalves80 and @Arcstur

Microtasks

Event Timeline

Ederporto set Due Date to Oct 18 2024, 3:00 AM.Oct 2 2024, 1:37 AM
Ederporto updated the task description. (Show Details)
Ederporto removed Due Date.
Ederporto added subscribers: Mgalves80, Arcstur, Ederporto.
debt renamed this task from Quickstatements 3.0 public documentation to Outreachy Round 29: Quickstatements 3.0 public documentation.Oct 3 2024, 3:13 PM
debt changed the task status from Open to In Progress.Dec 17 2024, 5:58 PM

Week 1 (Dec. 9 - 13) Update
Tasks Completed:

  • Deployed the Quickstatements3.0 application along with obtaining my Developer token
  • Deep dive into the Quickstatements v1 command syntax.
  • Creation of the test dataset for the v1 syntax.

Challenges faced:

  • Deploying the application proved to be a hassle at first, turns out it the "make shell" command was not picking the environment variables for $ROOT_DIR and $IMAGE.
  • Creating the test dataset.

Learnings:

  • Understanding the makefile that deploys the application.
  • Understanding the v1 command syntax

Week 2 (Dec. 16 - 20) Update
Tasks Completed:

  • Understanding the v2 command syntax

Tasks yet to be completed:

  • Understanding lexemes syntax
  • Creating test dataset for v2 command syntax and lexemes.

Challenges Faced:

  • I fell ill and as a result couldn't get much work done.

Week 3 (Dec. 23 - 27)
Tasks Completed:

  • Completed the test dataset for v1 command syntax.
  • Creating test dataset for v2 command syntax.
  • Exploring the test wikidata environment, creating properties and Items to be used for testing

Tasks yet to be completed:

  • Understanding lexemes syntax

Week 4 (Dec. 30 - Jan 3rd)
Tasks Completed:

  • Updating the v1 command syntax
  • Comprehensive testing of Quickstatements3.0 using v1 command syntax

Tasks yet to be completed:

  • Understanding lexemes syntax
  • Further testing of Quickstatements3.0 using v1 command syntax
  • Testing v2 command syntax

Week 5 (Jan 6th - Jan 10th)
Tasks Completed:

Completed testing of Quickstatements3.0 using v1 command syntax.
Drafting the outline of the Documentation

Tasks yet to be completed:

Understanding lexemes syntax
Testing v2 command syntax

Week 6 (Jan 13th - Jan 17th)
Tasks Completed:

Wrote 3rd blog post.
Finished the Documentation for V1 command syntax.
Created the dataset for integration tests

Tasks yet to be completed:

Understanding lexemes syntax
Testing v2 command syntax
Writing Documentation for v2 command syntax

Week 7 (Jan 20th - Jan 24th)
Tasks Completed:

Creation of test dataset for v2 command syntax
Comprehensive Testing of v2 command syntax
Writing Documentation for v2 command syntax

Tasks yet to be completed:

Putting the Documentation together
Understanding lexemes syntax

Week 8 (Jan 27th - Jan 31st)
Tasks Completed:

Completed and submitted first draft of Documentation

Week 9 (Jan 3rd - Feb 7th)
Tasks Completed:

  • Mentor feedback from the first draft of the Documentation
  • Made corrections to the Documentation and submitted for further review

Week 9 (Feb 3rd - Feb 7th)
Tasks Completed:

  • Mentor feedback from the first draft of the Documentation
  • Made corrections to the Documentation and submitted for further review

Week 10 (Feb 10th - Feb 14th)
Tasks Completed:

  • Made further corrections to the Documentation and submitted for further review.

Week 11 (Feb 17th - Feb 21st)
Tasks Completed:

  • Mentor review of Documentation
  • Final corrections to the Documentation.

Week 12 (Feb 24th - Feb 28th)
Tasks Completed:

  • Documentation is live
  • Made edits to issues pointed out by users

Week 13 (Mar 3rd - Mar 7th)
Tasks Completed:

  • Monitor the Quickstatements3.0 talk page for any user feedback concerning the Documentation
  • Make edits if necessary.
  • Wrote my final blog

This is the end of my internship. I am very proud of what I was able to accomplish, I'm more proud of the work the developers of the QS3.0 has done.

I appreciate all of my mentors, I'm thankful for the opportunity.