https://www.mediawiki.org/wiki/MediaWiki_Developer_Summit_2015#Schedule
Monday 26 January 3:30 Conference Room 2
Etherpad
@Spage is organizing this
Links
interactive examples:
- https://doc.wikimedia.org/mediawiki-core/master/js/#!/api/mw.Message has Code Editor and Live Preview
- https://www.mediawiki.org/wiki/API:Properties#imageinfo_.2F_ii actual API queries
- https://de.wikipedia.org/w/api.php?uselang=fr translated MediaWiki API doc
Conclusions
- The audience likes the idea of generated doc more than they use it.
- There's still a role for on-wiki documentation. Details of how to do something can be generated, but design and architecture work well on-wiki.
- volunteers (Rob Church et al) wrote documentation for admin and users on-wiki. (The session isn't about user and admin documentation, and no plan to change that.)
- A big win of documentation living with code is you -1 a patch until the same patch corrects the documentation.
- So continue to generate documentation from source code. But also publish documentation that lives with source code.
- For the latter need a scraper to push git docs onto wiki, e.g. https://www.mediawiki.org/wiki/Extension:Git2Pages
- Need to deal with multi-master issue: block or avoid wiki edits.
- So continue to generate documentation from source code. But also publish documentation that lives with source code.
- Remove overlap of generated doc and wiki doc, specifically method-level documentation and API documentation.