User:APaskulin (WMF)/History

Quickstart: My currently assigned tasks

Quarterly[edit]

October - December 2020

General

44 edits to mediawiki.org ^[1]
7 patches merged (3 XS, 2 S, 2 M) ^[2]
22 patches reviewed ^[3]
15 patches +2’d

API Portal

Opened 52 tasks ^[4]
Closed 64 tasks ^[5]
Closed 26 tasks assigned to me ^[6]
Completed private launch and soft launch
Conducted 9 user tests
Continued to maintain sprint logs and project plan

Outreach

Completed co-mentorship for Google Season of Docs
Co-hosted a Friends of the Docs meetup

July - September 2020

General

250 edits to mediawiki.org^[7]
13 patches merged (1 L, 2 S, rest XS)^[8]
14 patches reviewed^[9]
2 patches +2’d
3 TechCom meetings facilitated
Attended the API Specifications Conference^[10]

Architecture

Started building out architecture docs on mediawiki.org^[11]

User research and outreach

Hosted Wikimedia session at Write the Docs “Portland” writing day^[12]
Hosted two meetings of Wikimedia Friends of the Docs^[13]
Acted as co-mentor and co-administrator for Google Season of Docs^[14]

API Portal

Opened 83 tasks^[15]
Closed 60 tasks^[16]
Closed 26 tasks assigned to me^[17]
Completed design validation for skin^[18]
Completed acceptance testing for extension^[19]
Sent two project digests^[20]
Maintained a list of tasks across team members for five, two-week sprints, including which tasks were closed during each sprint^[21]
Developed style for reference docs^[22]

April - June 2020

General

488 edits to mediawiki.org (including sandbox pages)
4 patches merged (2 XS, 1 S, and 1 XL)
8 patches reviewed
First +2 (MediaWiki Core docs)
Found my first bug
Facilitation for 6 TechCom meetings
Guest on Between the Brackets podcast

Architecture

Joined the Wikimedia Foundation Architecture Team
Information design for architecture maturity model on mediawiki.org^[23]
Supported planning for architecture documentation strategy

User research and outreach

Rough version of a documentation metrics dashboard^[24]
Data analysis for "Was this documentation helpful?" gadget^[25]
Presented to the first meeting of Wikimedia Friends of the Docs^[26]
Mentor and co-administrator for Google Season of Docs^[27]
Launched weekly documentation office hours to support Foundation teams (12 sessions starting April 14)

Development of docs for the MediaWiki REST API

Published docs for 11 endpoints (100% of endpoints in v1)^[28]
Tested and published 45 code samples (100% of endpoints have code samples in curl, PHP, Python, and JavaScript)
Conducted three usability tests
Improved maintainability by reducing content length by 56% ^[29]
Published two tutorials^[30]^[31]

Documentation support for new hooks system

Edited doc comments for 446 hooks^[32]
Managed doc updates for new system^[33]
Updated MediaWikiHook template for new system^[34]
Doxygen config updates to support hook docs^[35]

API Portal

Completed design approval process with WMF design team
UI and UX development^[36]
Took on role of product owner
Managed the project plan, workflows, and content strategy^[37]
13 check-ins with HalloWelt
Opened 25 tasks (Closed 8)^[38]
Demoed the prototype at CPT demo meeting
Created the API Gateway stakeholders Google Group and sent two API Portal project digests^[39]

January - March 2020

Completed collaboration with contract designer, Liz, on Developer Portal design
Started hooks doc comment review project
Drafted the documentation plan for the API Gateway
Forked the Developer Portal prototype to create the API Gateway prototype
Tech docs offsite
Facilitation for TechCom
Evaluated two tools for automated API documentation
Wrote four MediaWiki REST API examples as Jupyter Notebooks
Participated in the Onboarding Working Group
Documented 8 new endpoints of the MediaWiki REST API
Attended Wikimedia All Hands
Researched improvements to the OAuth docs

October - December 2019

Refreshed onboarding docs for Wikimedia Engineering and CPT Developed content strategy for Developer Portal project and worked with designer to implement UI/UX Published docs for MediaWiki API integration tests Developed docs for MediaWiki Core REST API history endpoints and extension interface Mentor for Google Code-In Facilitation for TechCom CPT remote offsite

August - September 2019

Onboarding Developed docs for MediaWiki API integration tests Minor fixes for MediaWiki Doxygen docs Drafted user personas for documentation

Weekly[edit]

2020-2021 Q2

Q2 Week 1: 2020-10-05[edit]

Created a workboard for API Portal skin https://phabricator.wikimedia.org/project/board/4822/
Worked on API Portal main page https://api.wikimedia.org/w/index.php?title=Main_Page&type=revision&diff=220&oldid=6
Gave a demo of the API Portal at Tech-all https://drive.google.com/file/d/1LzT0fD1rL0ROhCaKKc740snCXKgrNBCM/view?usp=sharing
Reviewed templates created by Season of Docs participant https://www.mediawiki.org/w/index.php?search=User%3AGbahdeyboh%2FGSoD20&title=Special:Search&profile=advanced&fulltext=1&advancedSearch-current=%7B%7D&ns0=1&ns12=1&ns100=1&ns102=1&ns104=1&ns106=1
API Portal project management, code review, and task validation
Troubleshooting for API Portal bugs
Opened patch with improvements for API Portal https://gerrit.wikimedia.org/r/c/mediawiki/extensions/WikimediaApiPortalOAuth/+/632521
Fixed and closed T264202, T264628, and T262709
+2’d a one-line patch for the WikimediaApiPortalOAuth extension
Added content to the heuristics page https://www.mediawiki.org/w/index.php?title=Heuristics&type=revision&diff=4161023&oldid=4129864

Q2 Week 2: 2020-10-12[edit]

Reviewed 633566, 630318, 633557, 633856, 633861, 634068, 631565, 634335,
API Portal project management and task validation
Fixed T265409 Remove blue border on page action buttons
Opened T265495, T265507
Opened and abandoned https://gerrit.wikimedia.org/r/c/mediawiki/skins/WikimediaApiPortal/+/634081/
Edited GSoD work
Used styles and templates to make API Portal reference docs easier to create and maintain, reducing the number of characters used on the page by 35% (endpoint) and 61% (object) https://api.wikimedia.org/w/index.php?title=API_reference%2FCore_API%2FSearch%2FSearch_pages&type=revision&diff=284&oldid=195. https://api.wikimedia.org/w/index.php?title=API_reference%2FCore_API%2FSearch%2FSearch_result_object&type=revision&diff=297&oldid=191.
Added basic (without examples and cross-links) reference content to API Portal
Holiday on Monday

Q2 Week 3: 2020-10-19[edit]

Reviewed 634732 and 635300
API Portal project management and task validation
Wild attempt to fix some CSS bugs 635093
Worked on some designs for project messaging https://api.wikimedia.org/wiki/Template:Projects
Troubleshooted getting DiscussionTools to work on API Portal
Opened T266161, T266160, T266073
Opened a patch for T265815
Opened and got +2’d my first PHP patch, 635610 for T266161
Added a patchset to 635300 for CSS fixes
Worked on capability modeling and process with architecture team

Q2 Week 4: 2020-10-26[edit]

Reviewed 636130, 636158, and 637674
API Portal project management and task validation
Closed T265366 with CSS fix
Worked on displaying projects and languages in API Portal
Participated in event storming workshop
Participated in architecture planning

Q2 Week 5: 2020-11-02[edit]

Created a deck for docs principles https://docs.google.com/presentation/d/1oV30xIEerLyERHj05VopyS47yOiWzXmI-7IrX7QAoLM/edit#slide=id.g15105b408d_0_287
Reviewed architecture artifact
Reviewed 639281
Conducted first user test of API Portal and made updates
Worked on API Portal content
Opened T267449
Holiday on Tuesday

Q2 Week 6: 2020-11-09[edit]

Figured out issue with text wrapping for code samples (requires word break property and inline block)
Figured out issue with syntaxhighlight being limited to a number of lines
Conducted API Portal user tests
API Portal project management and task validation
Reviewed 639281, 639946, and 639925
Updated API Portal extension docs https://www.mediawiki.org/w/index.php?title=Extension%3AWikimediaApiPortalOAuth&type=revision&diff=4227564&oldid=4224042
Opened patch for T267811
Holidays on Wednesday, Thursday, and Friday

Q2 Week 7: 2020-11-16[edit]

Reviewed 640699
API Portal project management and task validation
Conducted API Portal user tests
Tested OAuth flows and opened T267996 and T268169
Worked on API Portal launch plan and opened T268288
Wrote up end-to-end test cases for OAuth, API Gateway, and API Portal and opened T268257
Tried to mitigate context switching between content development and project management
Completed https://api.wikimedia.org/wiki/API_reference/Feed/Featured_content
Improved tables on https://api.wikimedia.org/wiki/API_reference/Feed
GSoD review and mentoring

Q2 Week 8: 2020-11-23[edit]

Reviewed 643280
Tested end-to-end OAuth and API Gateway workflows
Conducted API Portal user tests
Discovered that the API Gateway doesn’t support Api-User-Agent headers as required by the User Agent policy, opened T268791, and removed them from the API Portal reference docs examples
Finished API reference docs for Core endpoint in the API Portal
Updated the JavaScript examples in the API Portal reference to be more concise
Holiday on Thursday and Friday

Q2 Week 9: 2020-11-30[edit]

API Portal project management and task validation
Google Season of Docs mentorship support and docs review
Figured out that I can easily add supplemental text to form inputs on the Create Client form, but not easily add tooltips. I’m guessing this is because tooltips carry a style as a result of their implementation as part of the client details view.
Reviewed 645062
Conducted API Portal user tests and an evaluation for compatibility with RTL languages
Did a live demo of the API Portal at the All Staff meeting
Participated in architecture modeling
Opened 645537 for improvements to API key management interface in the API Portal
Co-hosted a meetup of Wikimedia Friends of the Docs

Q2 Week 10: 2020-12-07[edit]

Updated Extension:OAuth to reflect https://gerrit.wikimedia.org/r/644547
API Portal project management and task validation
Worked on API Portal content
Reviewed 647088 and 647234
Responded to feedback on updates to API Portal create API key flow
Got back to zero unread messages in my email inbox :)
Decided that without a “depicts” feature for searching Commons, searching for images of a particular subject via the API isn’t helpful as an example use case.
Soft-launched the API Portal so that it is publicly visible prior to official launch next month

Q2 Week 11: 2020-12-14[edit]

Updated and merged 645537 (user experience improvements for the API Portal key management interface)
API Portal project management and task validation
Started adding short description API endpoints to the API Portal
Opened 650792 to fix short description API spec
Worked on API Portal getting started pages
Hosted API Portal project closeout celebration (slide deck)
Participated in architecture modeling
Published architecture event modeling to https://www.mediawiki.org/wiki/Wikimedia_system_model#Edit_collections

Q2 Week 12: 2020-12-21[edit]

Finished API Portal reference docs for page description endpoints
Reviewed Manual:Parser_cache draft on mw.org
Holidays Wednesday-Friday

2020-2021 Q1

Q1 Week 1: 2020-07-06[edit]

Vacation

Q1 Week 2 2020-07-13[edit]

Reviewed recent updates to hooks.txt and updated wiki docs
Reviewed patchsets for WikimediaApiPortalOAuth and OAuth extensions
API Portal project management
Imported ContentGrid and Colored Box templates to Wikitech
Documented Template:ContentGrid on mediawiki.org
Researched OAuth and security for https://phabricator.wikimedia.org/T253067
Updated REST API docs following configuration setting changes
Reviewed https://gerrit.wikimedia.org/r/c/mediawiki/core/+/613155
Learned the hard way to assign myself to a patch as a reviewer if I want to make sure my review gets seen prior to merging
Worked on word cloud tutorial https://paws-public.wmflabs.org/paws-public/User:APaskulin_(WMF)/word-cloud.ipynb

Q1 Week 3: 2020-07-20[edit]

Opened tasks for the API Portal and MediaWiki REST API
Co-hosted second meeting of Wikimedia Friends of the Docs and presented some favorite templates https://www.mediawiki.org/wiki/Wikimedia_technical_documentation:_Friends_of_the_Docs/Meetings/2020-07-21
Attended a virtual argumentation workshop through the Domain Driven Design group on Meetup
Responded to comment on architecture maturity model
Worked on content for API Portal
Tested user contribution endpoints and drafted docs
Worked on a draft of an architecture diagram for the API Gateway (https://app.diagrams.net/?state=%7B%22folderId%22:%220AMFQCwYg24uoUk9PVA%22,%22action%22:%22create%22,%22userId%22:%22115032417586964497221%22%7D#G1Rsa_McPTxyiq6ZoWqc5BFF8vOm_nxWiD)
Task management for WikimediaApiPortalOAuth and WikimediaApiPortal
Drafted individual tuning form
Researched wikifeeds endpoints for API Gateway

Q1 Week 4: 2020-07-27[edit]

Reviewed proposals for Google Season of Docs and submitted project selection
Kicked off planning for participation in the Writing Day at the (virtual) Write the Docs conference in two weeks
Project management support for the API Portal project
Reviewed technical decision making process doc
Updated Template:MediaWikiHook to support hooks with a single underscore in the name
Continued researching wikifeeds API for API Gateway
Submitted form for individual tuning conversation
Drafted OKRs for this quarter
Facilitation for TechCom
Documentation consultation with OKAPI team
Published initial draft of architecture docs

Q1 Week 5: 2020-08-03[edit]

Worked on design validation for WikimediaApiPortal skin
Completed permissions validation for API Portal on beta
Reviewed structured content store docs
Edited and published Indic workshop post on the Tech Blog https://techblog.wikimedia.org/2020/08/07/designing-technical-workshops-for-the-indic-community/
Project and task management for API Portal
Worked on documenting security best practices for the API Portal
Edited and sent user contributions API docs for review
Helped teammates to write their OKRs

Q1 Week 6: 2020-08-10[edit]

Write the Docs conference (Notes)
Worked on design validation of WikimediaApiPortal skin
Completed user contributions API docs
Hosted Tech Talk https://www.mediawiki.org/wiki/Wikimedia_Technical_Talks#Episode_6:_Retargeting_extensions_to_work_with_Parsoid
Facilitation for TechCom
Holiday on Friday

Q1 Week 7: 2020-08-17[edit]

Completed design validation of WikimediaApiPortal skin https://phabricator.wikimedia.org/T256793
Reviewed script for Phabricator instructional video
Project management for the API Portal project
Opened patches for T259953 and T260618
Announced the selected project for Google Season of Docs and kicked off community bonding phase
Worked to define a set of closable tasks for each sprint ahead of time
One year anniversary of working at WMF
Learned about OAuth and started working on updates to OAuth extension docs
Worked on user interface mockups for API Portal create and manage app views https://docs.google.com/drawings/d/1FPUkNWjodNc4Y4yUCS4fk_EEx-dQKbM6rzYOHy7KXcs/edit and shared via https://phabricator.wikimedia.org/T253067
Learned about Wikifeeds API
Reviews for architecture team

Q1 Week 8: 2020-08-24[edit]

Set up a MediaWikiDockerDev environment
Opened patches for seven small fixes for the API Portal skin
Architecture team offsite
Learned about OAuth T260944
Worked on Wikifeeds API docs
API Portal task validation

Q1 Week 9: 2020-08-31[edit]

Reviewed patches 621611, 623142, 624910, 624906, 623622, and 623099
Did documentation updates for https://phabricator.wikimedia.org/T259716
Opened patch for https://phabricator.wikimedia.org/T260620
Discussed T260309 and T260311 with Cindy
Worked on https://phabricator.wikimedia.org/T259042
Addressed https://phabricator.wikimedia.org/T262062

Q1 Week 10: 2020-09-07[edit]

Holiday on Monday
API Portal code review and product management
Updated OAuth extension docs
Created WikimediaApiPortal skin docs https://www.mediawiki.org/wiki/Skin:WikimediaApiPortal
Opened patch for API Portal T260306
Attended API Specifications Conference
Sent project digest

Q1 Week 11: 2020-09-14[edit]

API Portal project management
Set up Echo and ULS in my local environment
Published some minimal placeholder text to the prod portal main page
Kicked off Google season of docs
Implemented and verified footer for API Portal
Blog post review
API Portal code review and task validation
Reviewed and resolved T261692, T260630, T259735, T258759
Developed styles for API reference in Portal https://api.wikimedia.org/wiki/API_reference/Core_API/Search/Search_pages
Completed https://phabricator.wikimedia.org/T255483
Learned about OAuth and bot policies

Q1 Week 12: 2020-09-21[edit]

Worked on architecture team documentation
Requested review for API Portal reference styles
Worked on OAuth scopes for the API Portal
Code review for API Portal
Created Wikifeeds tutorial https://public.paws.wmcloud.org/User:APaskulin_(WMF)/Wikimedia-Feeds-API-Intro.ipynb

Q1 Week 13: 2020-09-28[edit]

Troubleshooting with Cindy
API Portal project management
Fixed some CSS bugs in the Portal skin
Opened patch for https://phabricator.wikimedia.org/T260944
Acceptance testing for WikimediaApiPortalOAuth extension
Drafted docs for new extension
Troubleshooting extension bugs

2019-2020 Q4

Q4 Week 14: 2020-06-29[edit]

Worked on UX for the API Portal
Project management for API Portal
Published tutorial for MediaWiki REST API https://paws-public.wmflabs.org/paws-public/User:APaskulin_(WMF)/en-wikipedia-images.ipynb
Facilitation for TechCom
Holiday on Friday

Q4 Week 13: 2020-06-22[edit]

Sent out second API Portal project digest
Support for Google Season of Docs
Published architecture maturity model
Added page, file, and language endpoints to the MediaWiki REST API docs
Experimental tutorials grid https://www.mediawiki.org/wiki/User:APaskulin_(WMF)/Sandbox/Wikimedia_Tutorials
Worked on UX for the API Portal

Q4 Week 12: 2020-06-15[edit]

Worked on API Portal project plan
Published https://www.mediawiki.org/wiki/API:REST_API/Conditional_requests
First Friends of the Docs meeting
Support for Google Season of Docs

Q4 Week 11: 2020-06-08[edit]

Created presentation on Extension:Mermaid
Information design for architecture maturity model wiki page
Published code samples in Python, PHP, and JavaScript for core REST API reference docs
Worked on API Portal design
Wrapped up this phase of hooks docs
Support for Google Season of Docs

Q4 Week 10: 2020-06-01[edit]

Worked on API Portal project plan
Support for Google Season of Docs
Published single page version of MediaWiki Core REST API docs
Added search endpoints to MediaWiki Core REST API docs
Facilitation for TechCom
Updated Template:MediaWikiHook
Worked on updates for Manual:Hooks

Q4 Week 9: 2020-05-25[edit]

Holiday on Monday
Interviewed for Between the Brackets podcast
Support for new hook system
Merged two patches for improvements to hooks docs on MediaWiki Doxygen
Merged a patch correcting a typo on hook interface doc comments
Support for Google Season of Docs
Reviewed docs patches^[40]^[41]
Worked on the MediaWiki Core REST API docs

Q4 Week 8: 2020-05-18[edit]

Drafted doc plan for new hooks system
Designed update for mediawikihook template
Worked on the single-page design for the MediaWiki Core REST API docs
Worked on API Portal workflows
Crated API Gateway stakeholders group and sent out first API Portal project digest
Support for Google Season of Docs
Facilitation for TechCom

Q4 Week 7: 2020-05-11[edit]

Kicked off Google Season of Docs as a co-admin for Wikimedia
Worked on updates to API integration test docs
Found my first bug
Finished spec for API Portal create app flow
Reviewed updates to the API Portal skin
Worked on stakeholder communications for the API Portal
Worked on API Portal workflows
Worked on app management flow for API Portal

Q4 Week 6: 2020-05-04[edit]

Facilitation for TechCom
Created documentation plan for new hook system^[42]
Worked on API Portal workflows
Drafted updated template format for MediaWikiHooks

Q4 Week 5: 2020-04-27[edit]

Finished single page version of MediaWiki REST API reference
Continued support for API Portal project
Facilitation for TechCom
Continued support for API Portal project
Data analysis for "Was this documentation helpful?" gadget

Q4 Week 4: 2020-04-20[edit]

Worked on single page version of MediaWiki REST API reference
Continued support for API Portal project
Added API Portal design for page options
Planned PHP and Python examples for MediaWiki REST API docs
Out of office Wednesday-Friday

Q4 Week 3: 2020-04-13[edit]

Completed hooks doc comment review patch
Continued support for API Portal project
Completed API Portal design review
Demoed API Portal for CPT

Q4 Week 2: 2020-04-06[edit]

Doc reviews for MediaWiki REST API
Worked on hooks doc comment review patch
Continued support for API Portal project
Started work on Wikimedia docs metrics
Worked on API Portal design review and updates

Q4 Week 1: 2020-03-30[edit]

Continued support for API Portal project
Worked on hooks doc comment review patch
Drafted docs for three MediaWiki REST API endpoints
Facilitation for TechCom

2019-2020 Q3

Q3 Week 13: 2020-03-23[edit]

Continued support for API Portal project
Worked on API Portal design updates
Worked on hooks doc comment review patch

Q3 Week 12: 2020-03-16[edit]

Started hooks doc comment review patch
Worked on MediaWiki REST API docs
Experimented with apiDoc tool
Worked on API Portal content
Facilitation for TechCom

Q3 Week 11: 2020-03-09[edit]

Responded to hooks docs task (phab:T246855)
Requested review for latest batch of MediaWiki REST API docs
Worked on API Portal design updates
Holiday on Monday

Q3 Week 10: 2020-03-02[edit]

Drafted and shared mw:Core_Platform_Team/Initiatives/API_Gateway/Documentation_Plan
Tech docs virtual offsite Monday and Tuesday
Facilitation for TechCom

Q3 Week 9: 2020-02-24[edit]

Strategy docs for dev portal
Drafted https://paws-public.wmflabs.org/paws-public/User:APaskulin_(WMF)/en-wikipedia-page-search.ipynb
Created a script to generate a swagger spec skeleton from a list of endpoints https://paws-public.wmflabs.org/paws-public/User:APaskulin_(WMF)/swagger-gen.ipynb
Reviewed docs for EventBus extension
Facilitation for TechCom

Q3 Week 8: 2020-02-17[edit]

Researched Wikimedia API change policies, and proposed changes to address phab:T244263.
Drafted docs for conditional requests to the MediaWiki REST API. Requested review through mediawiki.org.
Reviewed Core Platform team OKRs
Attended remote presentation from Stack Overflow. Interesting to learn that they encourage volunteer-built bots but they discourage those bots making edits; they want edits to come from a person.
Holiday on Friday

Q3 Week 7: 2020-02-10[edit]

Participated in API gateway planning
Read small wiki toolkits
Worked on mw:APaskulin_(WMF)/OAuth_2.0_notes
Facilitation for TechCom

Q3 Week 6: 2020-02-03[edit]

Compiled mw:APaskulin_(WMF)/OAuth_2.0_notes

Q3 Week 5: 2020-01-27[edit]

Wikimedia All Hands
- The movement strategy team handles translation by doing paid translations that are checked by volunteers.
- The (former) community engagement team is a great resource for docs support.
- The research team has regular contact with people who are using our content on their platforms, so they’re familiar with their use cases and experiences.

Q3 Week 4: 2020-01-20[edit]

Migrated MediaWiki REST API history endpoints guide into PAWS http://paws-public.wmflabs.org/paws-public/User:APaskulin_(WMF)/en-wikipedia-page-history.ipynb
Updated mw:API:REST_API/History with expandable organization
Drafted docs for MediaWiki REST API page and media file endpoints

Q3 Week 3: 2020-01-13[edit]

Drafted recommendations for onboarding working group
Reviewed and updated API integration test docs following packaging
Proof of concept for swagger-php mw:User:APaskulin (WMF)/Swagger annotations

Q3 Week 2: 2020-01-06[edit]

Worked on re-doing dev portal content strategy and prototype content
Joined Slack for green team standups (and goats channel)
Learned that Swagger Codegen exports HTML ->
- dynamic-html: Swagger UI with CSS and JS files
- html2: Two-column layout with generated examples in eight programming languages and expandable schemas, no sandbox, no examples
- html: Single-column layout with examples, no sandbox
Added HTML display to https://github.com/apaskulin/api-examples/blob/master/page-counts.ipynb
Joined hiring working group. Met with Corey to discuss next steps for evaluating and improving the onboarding process. Drafted a summary of the state of onboarding docs.

Q3 Week 1: 2019-12-30[edit]

Holidays Monday - Wednesday
Read When Not to Comment: Questions and Tradeoffs with API Documentation for C++ Projects(https://andrewhead.info/assets/pdf/when-not-to-comment.pdf)
- "Robillard and DeLine interviewed and surveyed developers about learning obstacles, recommending that common obstacles could be avoided if the intent of an API is documented, code examples cover non-trivial use cases and best practices, and documentation helps developers find API elements for their tasks, understand relevant parts of APIs’ internal behavior, and avoids fragmentation"
- Researchers grouped developers questions into: "how to do something, what code does, why it is behaving the way it is, finding where something is, who did something, and when they did it"
- "Recent research has proposed tools for automatically improving documentation. Such tools synthesize code examples [6, 21], generate method [19, 35] and parameter descriptions [36], mine API usage patterns (e.g., [20, 40]), collect insightful sentences describing APIs [37], and identify improvable documentation [39, 41]."
- "Distrust of documentation could lead to unnecessary searches: S6 visited the implementation to check for unexpected behavior when “it was actually documented properly, but I didn’t believe it.”
- See also:
  - https://people.eecs.berkeley.edu/~bjoern/papers/glassman-examplore-chi2018.pdf
  - https://dl.acm.org/doi/10.5555/2337223.2337255

2019-2020 Q2

Week 19: 2019-12-23[edit]

Worked on dev portal content
Holidays Tuesday - Friday

Week 18: 2019-12-16[edit]

Reviews for Google Code-in
Completed onboarding docs refresh
Completed offsite survey

Week 17: 2019-12-09[edit]

Reviews for Google Code-in
Reviewed dev portal content strategy with Evan
Team remote offsite
https://github.com/apaskulin/api-examples/blob/master/page-history.ipynb
Dev portal sync with Liz

Week 16: 2019-12-02[edit]

Note that the nowiki tag are helpful for documenting things like translate tags.
Completed open enrollment and surveys
Reviewed patches for Google Code-In
Helped Will create a comparison matrix for popular API spec formats
Finished content strategy doc for dev portal, shared with Evan and Kate
Reviewed service development proposal content from Eric (T239856)
Note taking for TechCom

Week 15: 2019-11-25[edit]

Moved https://phabricator.wikimedia.org/T87796 Add includes/filebackend/README as generated documentation page into done
Note taking for TechCom
Looked at tasks for upcoming Google Code In mentorship tasks
Review for updates to the docs for the compare revisions endpoint and wikidfiff2 extension
Updated REST API docs for history count limits
Worked on content strategy for dev portal
Added comments to the dev portal prototype
Holidays on Thursday and Friday

Week 14: 2019-11-18[edit]

Last week, I added a link to the API integration test docs from the mediawiki.org developer hub. The corrected syntax for a translated link with a description is:
```
{{ll|MediaWiki_API_Integration_Tests|<translate>API integration tests</translate>}} – <translate> learn to write API integration tests for MediaWiki using Mocha.</translate>
```
Note that
```

```
tags are added automatically by marking the page for translation and shouldn't be added manually. Wiki page references: Template:Localized_link and Help:Extension:Translate/Page_translation_administration.
In writing the above, I learned that translate tags are difficult to document because they're always picked up by MediaWiki, even within codeblocks. To bypass this, use a pre or a code tag and substitute the first angle bracket for
```
&lt;
```
The syntaxhighlight tag renders the text as-is without converting the character.
Joined CPT subteam standups
Note taking for TechCom
Experimented with the NotebookViewer extension in my wikifarm. I tried to create a Notebook:Test page with some example content, but I got a fatal error when trying to preview or save the page.
Finalized mw:API:REST_API/Extensions following excellent review feedback
NotebookViewer update: Cindy helped me troubleshoot the extension. She installed the dependencies and upgraded MediaWiki to 1.33 to support the getText() function in the core TextContent class. This gave us a parser error coming from the extension instead of a fatal error. I tried a few approaches to troubleshoot the parser error.
- Hypothesis: The sample text is invalid.
  - I tried several different sample texts with no success.
  - Minifying the json didn’t work
- Hypothesis: nbconvert is being used incorrectly
  - In this tutorial, they use nbformat to parse the notebook before loading it into nbconvert, which NotebookViewer isn't doing.
- Hypothesis: The text format being pulled out of MediaWiki isn’t correct.
  - https://doc.wikimedia.org/mediawiki-core/master/php/classTextContent.html#a5c0865039740fb1cfb6385ec2342689e
Updated docs for the compare revisions endpoint and wikidfiff2 extension.
- Looked for a page on English Wikipedia to use for examples without too many revisions.
  - Agapanthus
- Looked for two revisions to compare on English Wikipedia with a good spread of example content but not too long:
  - curl https://en.wikipedia.org/w/rest.php/v1/revision/9060718/compare/9284424

Week 13: 2019-11-11[edit]

Holiday on Monday
Updates to API integration test docs
- Updated wiki page with REST API functionality
- Moved content from the README to the wiki page
Updates to the REST API extension interface docs
- Added new example content from the example extension
- Met with Bill to review content
- Made updates based on review feedback
Met with Dev Portal designer and provided new hierarchy and placeholder content

Week 12: 2019-11-04[edit]

Updated Core REST API docs to reflect updates
Opened https://gerrit.wikimedia.org/r/548313 to adjust MediaWiki Doxygen output
Note taking for TechCom
Request feedback through Betterworks
Created a REST API template and chose mw:File:Database_-_The_Noun_Project.svg as the icon. Other considered icons:

Week 11: 2019-10-28[edit]

Updated History API docs to reflect updates
Updated https://www.mediawiki.org/wiki/Extension:Wikidiff2 for v1.9.0
Tried out the GitHub transclusion extension on the wikifarm
Ported Wikimedia Network Architecture diagram from Mural to draw.io
Worked with Bryan on the documentation-relation session for TechConf
Experimented with Markdown output in MediaWiki Doxygen to fix bug created by https://gerrit.wikimedia.org/r/539439

Week 10: 2019-10-21[edit]

Core REST API docs followups
- Completing review for compare revisions endpoint
- Updates to delta and size properties
Note taking for TechCom
Updates for https://gerrit.wikimedia.org/r/c/mediawiki/core/+/539439
Portal content strategy

Week 9: 2019-10-14[edit]

Core REST API docs followups
- Met with Toni about wikidiff2 format
REST API extension interface draft: https://www.mediawiki.org/wiki/API:REST/Extensions
Experimenting with an API doc template:
- https://www.mediawiki.org/wiki/API:REST/Extensions/Documentation_Template
- https://www.mediawiki.org/wiki/Template:RESTAPIEndpoint
Worked on drafting OKRs
Note taking for TechCom
Holiday on Monday

Week 8: 2019-10-07[edit]

Core REST API docs
- https://www.mediawiki.org/wiki/API:REST
- https://www.mediawiki.org/wiki/API:REST/History_API
Note taking for TechCom
Helping to onboard Nikki
Cultural orientation module 2

2019-2020 Q1

Week 7: 2019-09-30[edit]

Created a template for the REST API docs: mw:User:APaskulin_(WMF)/API_Template
Integration test docs
- Drafted examples and reviewed with Clara
- Published https://www.mediawiki.org/wiki/MediaWiki_API_Integration_Tests
- Opened https://gerrit.wikimedia.org/r/c/mediawiki/tools/api-testing/+/540952
Note taking for TechCom

Week 6: 2019-09-23[edit]

Published https://www.mediawiki.org/wiki/Wikimedia_Technical_Committee/Facilitator%27s_Guide
MediaWiki integration tests
- Reviewed doc needs for and opened https://phabricator.wikimedia.org/T233737
- Ran tests locally using MediaWiki Vagrant but couldn't get tests to pass.
Opened https://phabricator.wikimedia.org/T233976 Document REST API overview
Opened https://phabricator.wikimedia.org/T233977 Document REST API interface
Note taking for TechCom
Opened WIP patch for https://phabricator.wikimedia.org/T87796
Opened typo fix patch for Doxygen mainpage https://gerrit.wikimedia.org/r/c/mediawiki/core/+/539543
Following up on Kask docs
- Opened patch with a few small README updates https://gerrit.wikimedia.org/r/c/mediawiki/services/kask/+/539573

Week 5: 2019-09-16[edit]

Code review: https://gerrit.wikimedia.org/r/c/mediawiki/core/+/536742
Note taking for TechCom
Met with Corey and Tim
Local testing and task management for Doxygen Markdown project
Documentation portal content audit

Week 4: 2019-09-09[edit]

MediaWiki Doxygen docs: submitted https://gerrit.wikimedia.org/r/c/mediawiki/core/+/535684 (first patch merged 🎉)
Met with Evan and Bill to review the REST API integration for MediaWiki extensions.
Met with Evan to review and clarify personas, use cases, and technologies for the doc portal.
Met with Andre
AFK on Wednesday

Week 3: 2019-09-02[edit]

Completed sample text for doc portal design prototype
Wrote draft of docs user personas and reviewed with Sarah. See User:APaskulin (WMF)/Docs Personas.
Met with Cindy and Nick
Set up Gerrit and submitted (and abandoned) my first patch: https://gerrit.wikimedia.org/r/c/integration/docroot/+/534678
MediaWiki Doxygen docs
- Reviewed Timo's patch (post-merge) https://gerrit.wikimedia.org/r/c/mediawiki/core/+/534542
- Met with Timo to set up local Doxygen server
Mostly AFK on Wednesday

Week 2: 2019-08-26[edit]

Made level 0 edits to https://www.mediawiki.org/wiki/Kask.
Worked on planning for docs portal
Met with Daniel, Brad, Timo, Petr, and Sarah

Week 1: 2019-08-19[edit]

First week at the Foundation!

Set up my accounts and user pages
Met with Kate, Evan, Bill, Will, and Eric
Started content review notes
Started doc portal notes

Looking forward: Objectives

Spread knowledge of how to use Wikimedia tools
Support the Core Platform Team in documenting the MediaWiki platform and related services
Practice plain, clear, effective, translatable Global English
Learn about decentralized project organization

User:APaskulin (WMF)/History

Quarterly[edit]

Weekly[edit]

Q2 Week 1: 2020-10-05[edit]

Q2 Week 2: 2020-10-12[edit]

Q2 Week 3: 2020-10-19[edit]

Q2 Week 4: 2020-10-26[edit]

Q2 Week 5: 2020-11-02[edit]

Q2 Week 6: 2020-11-09[edit]

Q2 Week 7: 2020-11-16[edit]

Q2 Week 8: 2020-11-23[edit]

Q2 Week 9: 2020-11-30[edit]

Q2 Week 10: 2020-12-07[edit]

Q2 Week 11: 2020-12-14[edit]

Q2 Week 12: 2020-12-21[edit]

Q1 Week 1: 2020-07-06[edit]

Q1 Week 2 2020-07-13[edit]

Q1 Week 3: 2020-07-20[edit]

Q1 Week 4: 2020-07-27[edit]

Q1 Week 5: 2020-08-03[edit]

Q1 Week 6: 2020-08-10[edit]

Q1 Week 7: 2020-08-17[edit]

Q1 Week 8: 2020-08-24[edit]

Q1 Week 9: 2020-08-31[edit]

Q1 Week 10: 2020-09-07[edit]

Q1 Week 11: 2020-09-14[edit]

Q1 Week 12: 2020-09-21[edit]

Q1 Week 13: 2020-09-28[edit]

Q4 Week 14: 2020-06-29[edit]

Q4 Week 13: 2020-06-22[edit]

Q4 Week 12: 2020-06-15[edit]

Q4 Week 11: 2020-06-08[edit]

Q4 Week 10: 2020-06-01[edit]

Q4 Week 9: 2020-05-25[edit]

Q4 Week 8: 2020-05-18[edit]

Q4 Week 7: 2020-05-11[edit]

Q4 Week 6: 2020-05-04[edit]

Q4 Week 5: 2020-04-27[edit]

Q4 Week 4: 2020-04-20[edit]

Q4 Week 3: 2020-04-13[edit]

Q4 Week 2: 2020-04-06[edit]

Q4 Week 1: 2020-03-30[edit]

Q3 Week 13: 2020-03-23[edit]

Q3 Week 12: 2020-03-16[edit]

Q3 Week 11: 2020-03-09[edit]

Q3 Week 10: 2020-03-02[edit]

Q3 Week 9: 2020-02-24[edit]

Q3 Week 8: 2020-02-17[edit]

Q3 Week 7: 2020-02-10[edit]

Q3 Week 6: 2020-02-03[edit]

Q3 Week 5: 2020-01-27[edit]

Q3 Week 4: 2020-01-20[edit]

Q3 Week 3: 2020-01-13[edit]

Q3 Week 2: 2020-01-06[edit]

Q3 Week 1: 2019-12-30[edit]

Week 19: 2019-12-23[edit]

Week 18: 2019-12-16[edit]

Week 17: 2019-12-09[edit]

Week 16: 2019-12-02[edit]

Week 15: 2019-11-25[edit]

Week 14: 2019-11-18[edit]

Week 13: 2019-11-11[edit]

Week 12: 2019-11-04[edit]

Week 11: 2019-10-28[edit]

Week 10: 2019-10-21[edit]

Week 9: 2019-10-14[edit]

Week 8: 2019-10-07[edit]

Week 7: 2019-09-30[edit]

Week 6: 2019-09-23[edit]

Week 5: 2019-09-16[edit]

Week 4: 2019-09-09[edit]

Week 3: 2019-09-02[edit]

Week 2: 2019-08-26[edit]

Week 1: 2019-08-19[edit]

References[edit]

Navigation menu

Search