Event Timeline
The paste doesn't render as Remarkup! :-( So pasting it here
Q3 goal: "Plan agreed including goals, features, technology selections, and documentation workflows."
This document mentions the other four Q3 goals for "Documentation portal"
T308: A single Developer Hub plan agreed and documented
We have Data and developer hub with some content! Declare victory. Now to aggressively improve it.
- Goals: see dev.w.o page
- Features: coming
- technology selections: as expressed in T312: Technology selection for the Developer Hub with additions here
- documentation workflows: coming
What's most important to improve? I (Spage) am open to trusted actionable feedback so long as people understand that this is focused on encouraging third-party developers to access our data sets and experiment with our APIs. It is not documentation for MediaWiki developers, though improvements will benefit them.
The plan is divided into three areas: Content, Presentation and Technical
Content (my bias)
- must do T92945: Reflect in dev.wikimedia.org what Wikimedia offers to developers
- have to clean up "Developer hub" (T313: Future of the current Developer Hub at mediawiki.org)
- Add more documentation
- what? depends on T92941: Define personas for dev.wikimedia.org and T93048: Gather needs of WMF teams, Wikimedia contributors, and third-party developers for Data and developer hub <- Q3 goal
- I feel the biggest hole is persona Yanhui (data sets)
- then more for persona Alberto (Wikidata): both showcase articles and underlying Wikidata API improvement
- T335: Document the Content API in the Developer Hub is new and snazzy
- what? depends on T92941: Define personas for dev.wikimedia.org and T93048: Gather needs of WMF teams, Wikimedia contributors, and third-party developers for Data and developer hub <- Q3 goal
Content resourcing:
- full-time writer, more writer means more gets done
- Q3 goal "Documentation task force including volunteer editors." could help
- helps if we explain T304: Developer Hub contribution process
- Outside chance that some developer will be motivated to showcase their own work
Presentation
- T??? design pass over the Data and developer hub portal
- T??? design pass over the showcase pages
- a skin with navigation (T301: Define the look&feel of the Developer Hub) is a hard requirement if we're going big. (lots of designer and developer time)
- UX team's "Blueprint" skin may meet our needs
- custom skin will require a custom namespace (T369: Implement a namespace in mediawiki.org to host the developer hub)
- T??? Could be ambitious and skin generated code at doc.wikimedia.org and rest.wikimedia.org with this
- that way less jarring moving between written and generated
- ApiSandbox feels old, doesn't follow UI standards (T92893: Update ApiSandbox to MediaWiki appearance using OOjs UI)
- Smaller design needs
- TXXX icon for "next step"
- TXXX icon for the hub
- TXXX favicon
Presentation resourcing
Designer input time, front-end developer, back-end developer
Technical
- T372: Redirect dev.wikimedia.org to mediawiki.org is easy
- I still want , link to [View in sandbox] from API and examples (T89229: API Help should generate [try in ApiSandbox] link to Special:ApiSandbox#action=params from getExamples() T89680: Template:ApiEx on mw.org should have a link to "[view in ApiSandbox]".)
- T87802: "Search the docs" that searches static documentation as well as on-wiki doc namespaces. cross-site search makes this far more usable
Technical resourcing
Part-time engineer
General doc improvement
- huge list
- Q3 goal Documentation backlog properly maintained.
- Nothing here needs T91626: Technology to transclude git content into wiki pages but engs want to solve it
- other worthy goals
- (see Documentation board)
Other tasks
T322: Possibility to pair API documentation with user comments
@Spage, we already have https://www.mediawiki.org/wiki/Dev.wikimedia.org and #dev.wikimedia.org tasks. I don't think we need to add yet another document to the mix. Let's update and improve the ones we already have to plan, namely https://www.mediawiki.org/wiki/Dev.wikimedia.org and T308: A single Developer Hub plan agreed and documented. I will post my feedback about the current plan (docs) in T308.