Grants:Programs/Wikimedia Community Fund/Rapid Fund/Enhance the ProveIt gadget, part 3 (ID: 23036940)/Final Report
Application type: Standard application
Part 1: Project and impact
1. Describe the implemented activities and results achieved. Additionally, share which approaches were most effective in supporting you to achieve the results. (required)
I started by rewriting much of the Proveit gadget, in order to update it to more current standards, switch to the new Codex framework, and re-familiarize myself with the code. After the big rewrite, I started tackling one-by-one the various user requests and bug reports I had on my to-do list. Once all was ready, I deployed the new version and spent the next week or two attending new requests and fixing new bugs.
As to lessons learned, at the project level, I think communicating with users via the gadget talk page (https://en.wikipedia.org/wiki/Wikipedia_talk:ProveIt) worked really well, rather than trying to move the conversation to the grant page, or Phabricator project, or any other place. At a coding level, I think using Codex was definitely a worthwhile investment. I was not familiar with Codex or Vue (or any modern JavaScript framework, tbh) but once I overcame the initial learning curve, I really liked it and enjoyed learning more as I coded. Another thing that worked very well was using my WikitextParser.js (https://www.mediawiki.org/wiki/WikitextParser.js) to abstract away almost all the complicated wikitext parsing.
2. Documentation of your impact. Please use space below to share links that help tell your story, impact, and evaluation. (required)
Share links to:
- Project page on Meta-Wiki or any other Wikimedia project
- Dashboards and tools that you used to track contributions
- Some photos or videos from your event. Remember to share access.
You can also share links to:
- Important social media posts
- Surveys and their results
- Infographics and sound files
- Examples of content edited on Wikimedia projects
Detailed task list: https://en.wikipedia.org/wiki/Wikipedia_talk:ProveIt#Grant_closing
Usage stats: https://grafana.wikimedia.org/goto/KsjsIqCNg https://hashtags.wmcloud.org/graph/?query=proveit
Central documentation with many links to everything related to the gadget: https://www.mediawiki.org/wiki/ProveIt
Additionally, share the materials and resources that you used in the implementation of your project. (required)
For example:
- Training materials and guides
- Presentations and slides
- Work processes and plans
- Any other materials your team has created or adapted and can be shared with others
WikitextParser.js is a standalone wikitext parser written in JavaScript that can be used by gadgets and other JavaScript-based tools to parse wikitext efficiently. https://www.mediawiki.org/wiki/WikitextParser.js
3. To what extent do you agree with the following statements regarding the work carried out with this Rapid Fund? You can choose “not applicable” if your work does not relate to these goals. Required. Select one option per question. (required)
| A. Bring in participants from underrepresented groups | Not applicable |
| B. Create a more inclusive and connected culture in our community | Not applicable |
| C. Develop content about underrepresented topics/groups | Not applicable |
| D. Develop content from underrepresented perspectives | Not applicable |
| E. Encourage the retention of editors | Not applicable |
| F. Encourage the retention of organizers | Not applicable |
| G. Increased participants' feelings of belonging and connection to the movement | Not applicable |
| F. Other (optional) |
Part 2: Learning
4. In your application, you outlined some learning questions. What did you learn from these learning questions when you implemented your project? How do you hope to use this learnings in the future? You can recall these learning questions below. (required)
You can recall these learning questions below: I would like to further my understanding and skill on how to develop global gadgets, and continue sharing what I learn, as I've done in the past, see:
- https://meta.wikimedia.org/wiki/Learning_patterns/Developing_a_fully_internationalized_and_centralized_gadget
- https://www.mediawiki.org/wiki/Global_gadgets
- https://www.mediawiki.org/wiki/Multilingual_Templates_and_Modules
- https://www.mediawiki.org/wiki/Synchronizer
One thing I learned is that loading translated messages from Gerrit fails when the user has an old browser. Thus, it's good to have the English messages hard-coded in the gadget code, so that they can be used as a fallback when translations fail. This also makes fetching the messages unnecessary for English wikis, which in the case of Proveit makes up for the majority of the usage.
Another thing I learned is that it's convenient to annotate the code with links to Phabricator tasks that explain the reasons for this or that line of code, so that years later I (or someone else) can understand them and judge whether they're still relevant.
Lastly, I learned that Grafana stats are awesome (https://grafana.wikimedia.org/goto/KsjsIqCNg), I'll start using them for my other tools!
5. Did anything unexpected or surprising happen when implementing your activities? This can include both positive and negative situations. What did you learn from those experiences? (required)
At first I was reticent of using Codex, because I knew it would require not only a big rewrite of the gadget, but also I would have to learn a whole new framework I was not familiar with (and in fact I was not familiar with any modern JavaScript framework, like Angular, React, etc). Still, I decided to "give it a chance" and started tinkering with it. A couple days later I finally "got it" and everything started flowing. I didn't expect Vue or Codex to work so well. I learned how useful JavaScript frameworks can be.
6. What is your plan to share your project learnings and results with other community members? If you have already done it, describe how. (required)
I shared a detailed task list at https://en.wikipedia.org/wiki/Wikipedia_talk:ProveIt#Grant_closing
I also answered several individual threads at https://en.wikipedia.org/wiki/Wikipedia_talk:ProveIt and tasks at https://phabricator.wikimedia.org/tag/proveit-gadget/
Part 3: Metrics
7. Wikimedia Metrics results. (required)
In your application, you set some Wikimedia targets in numbers (Wikimedia metrics). In this section, you will describe the achieved results and provide links to the tools used.
| Target | Results | Comments and tools used | |
|---|---|---|---|
| Number of participants | 850 | 901 | https://hashtags.wmcloud.org/graph/?query=proveit |
| Number of editors | 850 | 901 | https://hashtags.wmcloud.org/graph/?query=proveit |
| Number of organizers | 1 | 1 | Some users helped me debug and test the new features, especially User:Iniquity and User:Johnjbarton |
| Wikimedia project | Target | Result - Number of created pages | Result - Number of improved pages |
|---|---|---|---|
| Wikipedia | 31000 | 0 | 36155 |
| Wikimedia Commons | |||
| Wikidata | |||
| Wiktionary | |||
| Wikisource | |||
| Wikimedia Incubator | |||
| Translatewiki | |||
| MediaWiki | |||
| Wikiquote | |||
| Wikivoyage | |||
| Wikibooks | |||
| Wikiversity | |||
| Wikinews | |||
| Wikispecies | |||
| Wikifunctions or Abstract Wikipedia |
8. Other Metrics results.
In your proposal, you could also set Other Metrics targets. Please describe the achieved results and provide links to the tools used if you set Other Metrics in your application.
| Other Metrics name | Metrics Description | Target | Result | Tools and comments |
|---|---|---|---|---|
| Active wikis | Proveit is enabled in 40+ wikis. However, https://hashtags.wmcloud.org/graph/?query=proveit reveals that it has actually been used in "only" 30 wikis. I'd like to increase that number to perhaps 32-33 wikis. | 34 | https://hashtags.wmcloud.org/graph/?query=proveit | |
9. Did you have any difficulties collecting data to measure your results? (required)
No
9.1. Please state what difficulties you had. How do you hope to overcome these challenges in the future? Do you have any recommendations for the Foundation to support you in addressing these challenges? (required)
Part 4: Financial reporting
[edit]10. Please state the total amount spent in your local currency. (required)
5000
11. Please state the total amount spent in US dollars. (required)
5000
12. Report the funds spent in the currency of your fund. (required)
Upload the financial report
12.2. If you have not already done so in your financial spending report, please provide information on changes in the budget in relation to your original proposal. (optional)
13. Do you have any unspent funds from the Fund?
No
13.1. Please list the amount and currency you did not use and explain why.
N/A
13.2. What are you planning to do with the underspent funds?
N/A
13.3. Please provide details of hope to spend these funds.
N/A
14.1. Are you in compliance with the terms outlined in the fund agreement?
Yes
14.2. Are you in compliance with all applicable laws and regulations as outlined in the grant agreement?
Yes
14.3. Are you in compliance with provisions of the United States Internal Revenue Code (“Code”), and with relevant tax laws and regulations restricting the use of the Funds as outlined in the grant agreement? In summary, this is to confirm that the funds were used in alignment with the WMF mission and for charitable/nonprofit/educational purposes.
Yes
15. If you have additional recommendations or reflections that don’t fit into the above sections, please write them here. (optional)
Review notes
[edit]Review notes from Program Officer:
N/A
Applicant's response to the review feedback.
N/A