User:APaskulin (WMF)/Documentation Portal

From Meta, a Wikimedia project coordination wiki
Jump to navigation Jump to search

Strategy[edit]

  • Focus on learning and creating
  • Frames things specifically in terms of Wikimedia, while mediawiki.org contains things that apply to the MediaWiki platform as a whole.
  • Every page is page one.

APIs and Tools[edit]

Wikimedia API[edit]

In planning phase. Docs for this API will live in the portal only.
  • Maintained by the Core Platform team

MediaWiki REST API[edit]

In development. Reference docs will be generated from the code and live in both the portal and mediawiki.org (to be implemented). Supporting docs for the MediaWiki REST API specific to its application for Wikimedia projects will live in the portal only. These docs will be replaced by the Wikimedia API once available.
  • Maintained by the Core Platform team

Pageview API[edit]

These docs include a swagger spec and some wiki content. If team agrees, wiki content could be modified slightly to transclude into the portal.

Event Streams API[edit]

These docs include a swagger spec and some wiki content. If team agrees, wiki content could be modified slightly to transclude into the portal.

ORES API[edit]

These docs include a swagger spec, some wiki content, and a static landing page. If team agrees, wiki content could be modified slightly to transclude into the portal.

Action API[edit]

The docs for this API are pretty mature docs: automated reference alongside tutorials and intro content. We could incorporate the automated docs into the portal and adjust the styling to make them fit nicely; we could also transclude some of the tutorials as is. Although I'm hesitant to include this style of API in the portal, we could augment the existing docs by creating content aimed at less experienced developers. If team agrees, we could incorporate https://tools.wmflabs.org/apps-gallery/ into the portal.

REST API (RESTBase)[edit]

We've decided not to include this technology in the portal.

Data Dumps[edit]

This is a one of our primary use cases, so I would consider it a must-have for the portal. There are already a lot of good docs in meta that we may be able to pull in somewhat directly. We could also offer the portal as an option to get the content out of meta since there has been a general migration of technical content from meta to mediawiki.org. There is also a static site that could be imported if the team agrees.

SPARQL[edit]

This feeds into a portal on wikidata with really good content. I’d recommend not going too deep on this on the portal, maybe just a landing page with an example and link out to wikidata for all the learn-sparql bits.

Gadgets Index & OOUI Library[edit]

OOUI has well-organized docs, including a fancy static site and some generated docs. I think it would be better to link out to these docs, at least initially. There’s a great guide to creating user scripts in the English Wikipedia, so it could be a cool opportunity to pull that out into the portal and make it more accessible cross-projects if community agrees.

Gadgets

OOUI Library

Supporting Content[edit]

User Questions[edit]

From https://upload.wikimedia.org/wikipedia/commons/4/48/The_MediaWiki_Web_API_and_How_to_use_it_-_San_Francisco_Wikipedia_Hackathon_2012.ogv

  • What are the limits for number of requests and amount of content returned?
  • Do I need an API key?
  • Can I get a dump of Wikipedia?
  • Can I get a list of URLs where I can download Wikipedia page HTML files?
  • How can I optimize my requests?
  • How to get everything I want all in one place?
  • How can I get the HTML content of a page?
  • What types of requests are going to be resource intensive? What kind of performance can I expect?
  • Can I make parallel requests?