User:APaskulin (WMF)/History

Week 17: 2019-12-09

• Last 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

Week 16: 2019-12-02

• 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

• 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

• 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

  <!--T:80-->

  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

  <

  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.
  • https://phabricator.wikimedia.org/T120697
  • https://github.com/valgog/wmf/blob/master/clickstream/ipython/Wikipedia%20Clickstream%20-%20Getting%20Started-Extended.ipynb
  • https://gerrit.wikimedia.org/g/mediawiki/extensions/NotebookViewer/+log/master
  • https://nbformat.readthedocs.io/en/latest/index.html
  • https://paws-public.wmflabs.org/paws-public/User:YuviPanda/replicahelper.ipynb?format=raw
• 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

• 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

• 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:
  • mw:File:Noun_project_organisation_symbol_1017384_cc.svg
  • mw:File:Documents_icon_-_noun_project_5020.svg
  • mw:File:Open_data_-_The_Noun_Project.svg
  • mw:File:Metadata_-_The_Noun_Project.svg

Week 11: 2019-10-28

• 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

• 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

• 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

• 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

Week 7: 2019-09-30

• 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

• 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

• 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

• 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

• 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

• 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

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